Halaman ini diterjemahkan oleh Cloud Translation API.

Class DocumentTab

Tab dokumen, yang berisi teks dan elemen lengkap seperti tabel dan daftar.

Ambil tab dokumen menggunakan Document.getTabs()[tabIndex].asDocumentTab().

// Get a specific document tab based on the tab ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
`addBookmark(position)`	`Bookmark`	Menambahkan `Bookmark` di `Position` yang diberikan.
`addFooter()`	`FooterSection`	Menambahkan bagian footer tab, jika tidak ada.
`addHeader()`	`HeaderSection`	Menambahkan bagian header tab, jika tidak ada.
`addNamedRange(name, range)`	`NamedRange`	Menambahkan `NamedRange`, yang merupakan `Range` yang memiliki nama dan ID untuk digunakan untuk pengambilan nanti.
`getBody()`	`Body`	Mengambil `Body` tab.
`getBookmark(id)`	`Bookmark`	Mendapatkan `Bookmark` dengan ID yang diberikan.
`getBookmarks()`	`Bookmark[]`	Mendapatkan semua objek `Bookmark` di tab.
`getFooter()`	`FooterSection`	Mengambil bagian footer tab, jika ada.
`getFootnotes()`	`Footnote[]`	Mengambil semua elemen `Footnote` dalam isi tab.
`getHeader()`	`HeaderSection`	Mengambil bagian header tab, jika ada.
`getNamedRangeById(id)`	`NamedRange`	Mendapatkan `NamedRange` dengan ID yang diberikan.
`getNamedRanges()`	`NamedRange[]`	Mendapatkan semua objek `NamedRange` di tab.
`getNamedRanges(name)`	`NamedRange[]`	Mendapatkan semua objek `NamedRange` di tab dengan nama yang diberikan.
`newPosition(element, offset)`	`Position`	Membuat `Position` baru, yang merupakan referensi ke lokasi di tab, relatif terhadap elemen tertentu.
`newRange()`	`RangeBuilder`	Membuat builder yang digunakan untuk membuat objek `Range` dari elemen tab.

Dokumentasi mendetail

`addBookmark(position)`

Menambahkan Bookmark di Position yang diberikan.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body and adds a paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = documentTab.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = documentTab.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

Parameter

Nama	Jenis	Deskripsi
`position`	`Position`	Posisi bookmark baru.

Pulang pergi

Bookmark — Bookmark baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`addFooter()`

Menambahkan bagian footer tab, jika tidak ada.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a footer to the tab.
const footer = documentTab.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Pulang pergi

FooterSection — Footer tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`addHeader()`

Menambahkan bagian header tab, jika tidak ada.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a header to the tab.
const header = documentTab.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Pulang pergi

HeaderSection — Header tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`addNamedRange(name, range)`

Menambahkan NamedRange, yang merupakan Range yang memiliki nama dan ID untuk digunakan untuk pengambilan nanti. Nama tidak harus unik, bahkan di seluruh tab; beberapa rentang yang berbeda dalam dokumen yang sama dapat memiliki nama yang sama, seperti class di HTML. Sebaliknya, ID bersifat unik dalam dokumen, seperti ID di HTML. Setelah menambahkan NamedRange, Anda tidak dapat mengubahnya, Anda hanya dapat menghapusnya.

Setiap skrip yang mengakses tab dapat mengakses NamedRange. Untuk menghindari konflik yang tidak disengaja antara skrip, pertimbangkan untuk menambahkan awalan nama rentang dengan string unik.

// Creates a named range that includes every table in a tab by its ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());

Parameter

Nama	Jenis	Deskripsi
`name`	`String`	Nama untuk rentang, yang tidak perlu unik; nama rentang harus antara 1-256 karakter.
`range`	`Range`	Rentang elemen yang akan dikaitkan dengan nama; rentang dapat berupa hasil penelusuran atau dibuat secara manual dengan `newRange()`.

Pulang pergi

NamedRange — NamedRange.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getBody()`

Mengambil Body tab.

Tab dapat berisi berbagai jenis bagian (misalnya, HeaderSection, FooterSection). Bagian aktif untuk tab adalah Body.

Metode elemen di DocumentTab didelegasikan ke Body.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body.
const body = documentTab.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Pulang pergi

Body — Bagian isi tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getBookmark(id)`

Mendapatkan Bookmark dengan ID yang diberikan. Metode ini menampilkan null jika tidak ada Bookmark tersebut dalam tab ini.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the bookmark by its ID.
const bookmark = documentTab.getBookmark('id.xyz654321');

// If the bookmark exists within the tab, logs the character offset of its
// position to the console. Otherwise, logs 'No bookmark exists with the given
// ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Parameter

Nama	Jenis	Deskripsi
`id`	`String`	ID untuk `Bookmark`.

Pulang pergi

Bookmark — Bookmark dengan ID yang diberikan, atau null jika tidak ada Bookmark tersebut dalam tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getBookmarks()`

Mendapatkan semua objek Bookmark di tab.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets all of the bookmarks in the tab.
const bookmarks = documentTab.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Pulang pergi

Bookmark[] — Array objek Bookmark di tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getFooter()`

Mengambil bagian footer tab, jika ada.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's footer and logs it to the console.
console.log(documentTab.getFooter().getText());

Pulang pergi

FooterSection — Footer tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getFootnotes()`

Mengambil semua elemen Footnote dalam isi tab.

Panggilan ke getFootnotes menyebabkan iterasi pada elemen tab. Untuk tab besar, hindari panggilan yang tidak perlu ke metode ini.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the first footnote.
const footnote = documentTab.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Pulang pergi

Footnote[] — Catatan kaki tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getHeader()`

Mengambil bagian header tab, jika ada.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's header and logs it to the console.
console.log(documentTab.getHeader().getText());

Pulang pergi

HeaderSection — Header tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNamedRangeById(id)`

Mendapatkan NamedRange dengan ID yang diberikan. Metode ini menampilkan null jika tidak ada NamedRange seperti itu di tab. Nama tidak harus unik, bahkan di seluruh tab; beberapa rentang yang berbeda dalam dokumen yang sama dapat memiliki nama yang sama, seperti class dalam HTML. Sebaliknya, ID bersifat unik dalam tab, seperti ID di HTML.

Parameter

Nama	Jenis	Deskripsi
`id`	`String`	ID rentang, yang unik dalam tab.

Pulang pergi

NamedRange — NamedRange dengan ID yang diberikan, atau null jika tidak ada rentang tersebut di tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNamedRanges()`

Mendapatkan semua objek NamedRange di tab.

NamedRange dapat diakses oleh skrip apa pun yang mengakses tab. Untuk menghindari konflik yang tidak diinginkan antar-skrip, pertimbangkan untuk menambahkan awalan nama rentang dengan string unik.

Pulang pergi

NamedRange[] — Array objek NamedRange di tab, yang mungkin mencakup beberapa rentang dengan nama yang sama.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNamedRanges(name)`

Mendapatkan semua objek NamedRange di tab dengan nama yang diberikan. Nama tidak harus unik, bahkan di seluruh tab; beberapa rentang yang berbeda dalam dokumen yang sama dapat memiliki nama yang sama, seperti class di HTML. Sebaliknya, ID bersifat unik dalam tab, seperti ID dalam HTML.

NamedRange dapat diakses oleh skrip apa pun yang mengakses tab. Untuk menghindari konflik yang tidak diinginkan antar-skrip, pertimbangkan untuk menambahkan awalan nama rentang dengan string unik.

Parameter

Nama	Jenis	Deskripsi
`name`	`String`	Nama rentang, yang tidak harus unik.

Pulang pergi

NamedRange[] — Array objek NamedRange di tab dengan nama yang diberikan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`newPosition(element, offset)`

Membuat Position baru, yang merupakan referensi ke lokasi di tab, relatif terhadap elemen tertentu. Kursor pengguna direpresentasikan sebagai Position, di antara penggunaan lainnya.

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parameter

Nama	Jenis	Deskripsi
`element`	`Element`	Elemen yang berisi `Position` yang baru dibuat; elemen ini harus berupa elemen `Text` atau elemen penampung seperti `Paragraph`.
`offset`	`Integer`	Untuk elemen `Text`, jumlah karakter sebelum `Position`; untuk elemen lain, jumlah elemen turunan sebelum `Position` dalam elemen penampung yang sama.

Pulang pergi

Position — Position baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`newRange()`

Membuat builder yang digunakan untuk membuat objek Range dari elemen tab.

// Change the user's selection to a range that includes every table in the tab.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Pulang pergi

RangeBuilder — Builder baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents