Class TableOfContents

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 mengetahui informasi selengkapnya tentang struktur dokumen, lihat panduan untuk memperluas kemampuan Google Dokumen.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
clear()TableOfContentsMengosongkan isi elemen.
copy()TableOfContentsMenampilkan salinan mendalam yang terpisah dari elemen saat ini.
editAsText()TextMendapatkan versi Text dari elemen saat ini, untuk diedit.
findElement(elementType)RangeElementMenelusuri konten elemen untuk turunan dari jenis yang ditentukan.
findElement(elementType, from)RangeElementMenelusuri konten elemen untuk turunan dari jenis yang ditentukan, mulai dari RangeElement yang ditentukan.
findText(searchPattern)RangeElementMenelusuri konten elemen untuk pola teks yang ditentukan menggunakan ekspresi reguler.
findText(searchPattern, from)RangeElementMenelusuri konten elemen untuk pola teks yang ditentukan, mulai dari teks tertentu hasil penelusuran.
getAttributes()ObjectMengambil atribut elemen.
getChild(childIndex)ElementMengambil elemen turunan pada indeks turunan yang ditentukan.
getChildIndex(child)IntegerMengambil indeks turunan untuk elemen turunan yang ditentukan.
getLinkUrl()StringMengambil URL link.
getNextSibling()ElementMengambil elemen yang seinduk berikutnya dari elemen.
getNumChildren()IntegerMengambil jumlah turunan.
getParent()ContainerElementMengambil elemen induk elemen.
getPreviousSibling()ElementMengambil elemen yang seinduk sebelumnya dari elemen.
getText()StringMengambil konten elemen sebagai string teks.
getTextAlignment()TextAlignmentMendapatkan perataan teks.
getType()ElementTypeMengambil ElementType elemen.
isAtDocumentEnd()BooleanMenentukan apakah elemen berada di akhir Document.
removeFromParent()TableOfContentsMenghapus elemen dari induknya.
replaceText(searchPattern, replacement)ElementMengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi.
setAttributes(attributes)TableOfContentsMenetapkan atribut elemen.
setLinkUrl(url)TableOfContentsMenetapkan URL link.
setTextAlignment(textAlignment)TableOfContentsMenetapkan perataan teks.

Dokumentasi mendetail

clear()

Mengosongkan isi elemen.

Pulang pergi

TableOfContents — Elemen saat ini.


copy()

Menampilkan salinan mendalam yang terpisah dari elemen saat ini.

Setiap elemen turunan yang ada dalam elemen tersebut juga akan disalin. Elemen baru ini tidak memiliki orang tua.

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 dari elemen saat ini, untuk diedit.

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

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

var 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 dari elemen saat ini


findElement(elementType)

Menelusuri konten elemen untuk turunan dari jenis yang ditentukan.

Parameter

NamaJenisDeskripsi
elementTypeElementTypeJenis 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 turunan dari jenis yang ditentukan, mulai dari RangeElement yang ditentukan.

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

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parameter

NamaJenisDeskripsi
elementTypeElementTypeJenis elemen yang akan ditelusuri.
fromRangeElementHasil penelusuran yang akan ditelusuri.

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 sepenuhnya didukung, seperti grup tangkapan dan pengubah mode.

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

Parameter

NamaJenisDeskripsi
searchPatternStringpola untuk mencari

Pulang pergi

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

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 teks tertentu hasil penelusuran.

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

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

Parameter

NamaJenisDeskripsi
searchPatternStringpola untuk mencari
fromRangeElementhasil pencarian untuk mencari

Pulang pergi

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

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 di mana masing-masing nama properti sesuai dengan item dalam enumerasi DocumentApp.Attribute.

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

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

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

// Log the paragraph attributes.
for (var 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.

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

// Obtain the first element in the tab.
var 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

NamaJenisDeskripsi
childIndexIntegerIndeks 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

NamaJenisDeskripsi
childElementElemen 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 yang seinduk berikutnya dari elemen.

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

Pulang pergi

Element — Elemen yang seinduk 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.

var 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 yang seinduk sebelumnya dari elemen.

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

Pulang pergi

Element — Elemen yang seinduk 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 teks {i>alignment<i} atau jika perataan teks belum pernah disetel

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 elemen yang tepat.

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

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

var 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.

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

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var 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.

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

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

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

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

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

Parameter

NamaJenisDeskripsi
searchPatternStringpola regex untuk mencari
replacementStringteks yang 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 di enumerasi DocumentApp.Attribute dan setiap nilai properti adalah nilai baru yang akan diterapkan.

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

// Define a custom paragraph style.
var 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.
var par = body.appendParagraph('A paragraph with custom style.');

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

Parameter

NamaJenisDeskripsi
attributesObjectAtribut 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

NamaJenisDeskripsi
urlStringURL 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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

NamaJenisDeskripsi
textAlignmentTextAlignmentjenis 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