Halaman ini diterjemahkan oleh Cloud Translation API.

Class TableOfContents

Elemen yang berisi daftar isi. TableOfContents dapat berisi elemen ListItem, Paragraph, dan Table, meskipun konten TableOfContents biasanya dibuat secara otomatis oleh Google Dokumen. Untuk informasi selengkapnya tentang struktur dokumen, lihat panduan untuk memperluas Google Dokumen.

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
`clear()`	`TableOfContents`	Menghapus konten elemen.
`copy()`	`TableOfContents`	Menampilkan salinan mendalam yang terpisah dari elemen saat ini.
`editAsText()`	`Text`	Mendapatkan versi `Text` elemen saat ini, untuk diedit.
`findElement(elementType)`	`RangeElement`	Menelusuri konten elemen untuk menemukan turunan dari jenis yang ditentukan.
`findElement(elementType, from)`	`RangeElement`	Menelusuri konten elemen untuk mencari turunan dari jenis yang ditentukan, mulai dari `RangeElement` yang ditentukan.
`findText(searchPattern)`	`RangeElement`	Menelusuri konten elemen untuk pola teks yang ditentukan menggunakan ekspresi reguler.
`findText(searchPattern, from)`	`RangeElement`	Menelusuri konten elemen untuk pola teks yang ditentukan, mulai dari hasil penelusuran tertentu.
`getAttributes()`	`Object`	Mengambil atribut elemen.
`getChild(childIndex)`	`Element`	Mengambil elemen turunan pada indeks turunan yang ditentukan.
`getChildIndex(child)`	`Integer`	Mengambil indeks turunan untuk elemen turunan yang ditentukan.
`getLinkUrl()`	`String`	Mengambil URL link.
`getNextSibling()`	`Element`	Mengambil elemen pasangan berikutnya dari elemen.
`getNumChildren()`	`Integer`	Mengambil jumlah turunan.
`getParent()`	`ContainerElement`	Mengambil elemen induk elemen.
`getPreviousSibling()`	`Element`	Mengambil elemen saudara sebelumnya dari elemen.
`getText()`	`String`	Mengambil konten elemen sebagai string teks.
`getTextAlignment()`	`TextAlignment`	Mendapatkan perataan teks.
`getType()`	`ElementType`	Mengambil `ElementType` elemen.
`isAtDocumentEnd()`	`Boolean`	Menentukan apakah elemen berada di akhir `Document`.
`removeFromParent()`	`TableOfContents`	Menghapus elemen dari induknya.
`replaceText(searchPattern, replacement)`	`Element`	Mengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi reguler.
`setAttributes(attributes)`	`TableOfContents`	Menetapkan atribut elemen.
`setLinkUrl(url)`	`TableOfContents`	Menetapkan URL link.
`setTextAlignment(textAlignment)`	`TableOfContents`	Menetapkan perataan teks.

Dokumentasi mendetail

`clear()`

Menghapus konten elemen.

Pulang pergi

TableOfContents — Elemen saat ini.

`copy()`

Menampilkan salinan mendalam yang terpisah dari elemen saat ini.

Semua elemen turunan yang ada dalam elemen juga akan disalin. Elemen baru tidak memiliki induk.

Pulang pergi

TableOfContents — Salinan 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

`editAsText()`

Mendapatkan versi Text elemen saat ini, untuk diedit.

Gunakan editAsText untuk memanipulasi konten elemen sebagai teks kaya. Mode editAsText mengabaikan elemen non-teks (seperti InlineImage dan HorizontalRule).

Elemen turunan yang sepenuhnya berada dalam rentang teks yang dihapus akan dihapus dari elemen.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Pulang pergi

Text — versi teks elemen saat ini

`findElement(elementType)`

Menelusuri konten elemen untuk menemukan turunan dari jenis yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`elementType`	`ElementType`	Jenis elemen yang akan ditelusuri.

Pulang pergi

RangeElement — Hasil penelusuran yang menunjukkan posisi elemen penelusuran.

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

`findElement(elementType, from)`

Menelusuri konten elemen untuk mencari turunan dari jenis yang ditentukan, mulai dari RangeElement yang ditentukan.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parameter

Nama	Jenis	Deskripsi
`elementType`	`ElementType`	Jenis elemen yang akan ditelusuri.
`from`	`RangeElement`	Hasil penelusuran yang akan digunakan untuk melakukan penelusuran.

Pulang pergi

RangeElement — Hasil penelusuran yang menunjukkan posisi berikutnya dari elemen penelusuran.

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

`findText(searchPattern)`

Menelusuri konten elemen untuk pola teks yang ditentukan menggunakan ekspresi reguler.

Sebagian fitur ekspresi reguler JavaScript tidak didukung sepenuhnya, seperti grup pengambilan dan pengubah mode.

Pola ekspresi reguler yang disediakan dicocokkan secara independen dengan setiap blok teks yang terdapat dalam elemen saat ini.

Parameter

Nama	Jenis	Deskripsi
`searchPattern`	`String`	pola yang akan ditelusuri

Pulang pergi

RangeElement — hasil penelusuran yang menunjukkan posisi teks penelusuran, atau null jika tidak ada kecocokan

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

`findText(searchPattern, from)`

Menelusuri konten elemen untuk pola teks yang ditentukan, mulai dari hasil penelusuran tertentu.

Sebagian fitur ekspresi reguler JavaScript tidak didukung sepenuhnya, seperti grup pengambilan dan pengubah mode.

Pola ekspresi reguler yang disediakan dicocokkan secara independen dengan setiap blok teks yang terdapat dalam elemen saat ini.

Parameter

Nama	Jenis	Deskripsi
`searchPattern`	`String`	pola yang akan ditelusuri
`from`	`RangeElement`	hasil penelusuran yang akan digunakan untuk menelusuri

Pulang pergi

RangeElement — hasil penelusuran yang menunjukkan posisi berikutnya dari teks penelusuran, atau null jika tidak ada kecocokan

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

`getAttributes()`

Mengambil atribut elemen.

Hasilnya adalah objek yang berisi properti untuk setiap atribut elemen yang valid dengan setiap nama properti sesuai dengan item dalam enumerasi DocumentApp.Attribute.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Pulang pergi

Object — Atribut elemen.

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

`getChild(childIndex)`

Mengambil elemen turunan pada indeks turunan yang ditentukan.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	Indeks elemen turunan yang akan diambil.

Pulang pergi

Element — Elemen turunan pada indeks yang ditentukan.

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

`getChildIndex(child)`

Mengambil indeks turunan untuk elemen turunan yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`child`	`Element`	Elemen turunan yang indeksnya akan diambil.

Pulang pergi

Integer — Indeks turunan.

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

`getLinkUrl()`

Mengambil URL link.

Pulang pergi

String — URL link, atau null jika elemen berisi beberapa nilai untuk atribut ini

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

`getNextSibling()`

Mengambil elemen pasangan berikutnya dari elemen.

Saudara berikutnya memiliki induk yang sama dan mengikuti elemen saat ini.

Pulang pergi

Element — Elemen sibling berikutnya.

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

`getNumChildren()`

Mengambil jumlah turunan.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Pulang pergi

Integer — Jumlah turunan.

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

`getParent()`

Mengambil elemen induk elemen.

Elemen induk berisi elemen saat ini.

Pulang pergi

ContainerElement — Elemen induk.

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

`getPreviousSibling()`

Mengambil elemen saudara sebelumnya dari elemen.

Saudara sebelumnya memiliki induk yang sama dan mendahului elemen saat ini.

Pulang pergi

Element — Elemen sibling sebelumnya.

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

`getText()`

Mengambil konten elemen sebagai string teks.

Pulang pergi

String — konten elemen sebagai string teks

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

`getTextAlignment()`

Mendapatkan perataan teks. Jenis perataan yang tersedia adalah DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, dan DocumentApp.TextAlignment.SUPERSCRIPT.

Pulang pergi

TextAlignment — jenis perataan teks, atau null jika teks berisi beberapa jenis perataan teks atau jika perataan teks belum pernah ditetapkan

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

`getType()`

Mengambil ElementType elemen.

Gunakan getType() untuk menentukan jenis persis elemen tertentu.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Pulang pergi

ElementType — Jenis elemen.

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

`isAtDocumentEnd()`

Menentukan apakah elemen berada di akhir Document.

Pulang pergi

Boolean — Apakah elemen berada di akhir 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

`removeFromParent()`

Menghapus elemen dari induknya.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Pulang pergi

TableOfContents — Elemen yang dihapus.

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

`replaceText(searchPattern, replacement)`

Mengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi reguler.

Pola penelusuran diteruskan sebagai string, bukan objek ekspresi reguler JavaScript. Oleh karena itu, Anda harus meng-escape garis miring terbalik dalam pola.

Metode ini menggunakan library ekspresi reguler RE2 Google, yang membatasi sintaksis yang didukung.

Pola ekspresi reguler yang disediakan dicocokkan secara independen dengan setiap blok teks yang terdapat dalam elemen saat ini.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

Parameter

Nama	Jenis	Deskripsi
`searchPattern`	`String`	pola ekspresi reguler yang akan ditelusuri
`replacement`	`String`	teks yang akan digunakan sebagai pengganti

Pulang pergi

Element — elemen saat ini

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

`setAttributes(attributes)`

Menetapkan atribut elemen.

Parameter atribut yang ditentukan harus berupa objek dengan setiap nama properti adalah item dalam enumerasi DocumentApp.Attribute dan setiap nilai properti adalah nilai baru yang akan diterapkan.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parameter

Nama	Jenis	Deskripsi
`attributes`	`Object`	Atribut elemen.

Pulang pergi

TableOfContents — Elemen saat ini.

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

`setLinkUrl(url)`

Menetapkan URL link.

Parameter

Nama	Jenis	Deskripsi
`url`	`String`	URL link

Pulang pergi

TableOfContents — elemen saat ini

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

`setTextAlignment(textAlignment)`

Menetapkan perataan teks. Jenis perataan yang tersedia adalah DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, dan DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

Nama	Jenis	Deskripsi
`textAlignment`	`TextAlignment`	jenis perataan teks yang akan diterapkan

Pulang pergi

TableOfContents — elemen saat ini

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