Elemen yang merepresentasikan bagian catatan kaki. FootnoteSection
berisi teks yang
terkait dengan Footnote
. FootnoteSection
dapat berisi elemen ListItem
atau
Paragraph
. Untuk mengetahui informasi selengkapnya tentang struktur dokumen, lihat panduan memperluas Google Dokumen.
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
appendParagraph(paragraph) | Paragraph | Menambahkan Paragraph yang ditentukan. |
appendParagraph(text) | Paragraph | Membuat dan menambahkan Paragraph baru yang berisi konten teks yang ditentukan. |
clear() | FootnoteSection | Menghapus konten elemen. |
copy() | FootnoteSection | Menampilkan salinan mendalam dan terpisah dari elemen saat ini. |
editAsText() | Text | Mendapatkan versi Text dari elemen saat ini, untuk diedit. |
findElement(elementType) | RangeElement | Menelusuri konten elemen untuk turunan dari jenis yang ditentukan. |
findElement(elementType, from) | RangeElement | Menelusuri konten elemen untuk 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. |
getNextSibling() | Element | Mengambil elemen seinduk elemen berikutnya. |
getNumChildren() | Integer | Mengambil jumlah turunan. |
getParagraphs() | Paragraph[] | Mengambil semua Paragraphs yang terdapat dalam bagian tersebut (termasuk ListItems ). |
getParent() | ContainerElement | Mengambil elemen induk elemen. |
getPreviousSibling() | Element | Mengambil elemen seinduk elemen sebelumnya. |
getText() | String | Mengambil konten elemen sebagai string teks. |
getTextAlignment() | TextAlignment | Mendapatkan perataan teks. |
getType() | ElementType | Mengambil ElementType elemen. |
insertParagraph(childIndex, paragraph) | Paragraph | Menyisipkan Paragraph yang ditentukan pada indeks yang ditentukan. |
insertParagraph(childIndex, text) | Paragraph | Membuat dan menyisipkan Paragraph baru pada indeks yang ditentukan, yang berisi konten teks
yang ditentukan. |
removeChild(child) | FootnoteSection | Menghapus elemen turunan yang ditentukan. |
removeFromParent() | FootnoteSection | Menghapus elemen dari induknya. |
replaceText(searchPattern, replacement) | Element | Mengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi reguler. |
setAttributes(attributes) | FootnoteSection | Menetapkan atribut elemen. |
setText(text) | FootnoteSection | Menetapkan konten sebagai teks biasa. |
setTextAlignment(textAlignment) | FootnoteSection | Menetapkan perataan teks. |
Dokumentasi mendetail
appendParagraph(paragraph)
Menambahkan Paragraph
yang ditentukan.
Gunakan versi appendParagraph
ini saat menambahkan salinan Paragraph
yang sudah ada.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
paragraph | Paragraph | paragraf untuk ditambahkan |
Return
Paragraph
— paragraf yang ditambahkan
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
appendParagraph(text)
Membuat dan menambahkan Paragraph
baru yang berisi konten teks yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
text | String | konten teks paragraf |
Return
Paragraph
— paragraf 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
clear()
copy()
Menampilkan salinan mendalam dan terpisah dari elemen saat ini.
Setiap elemen turunan yang ada dalam elemen juga akan disalin. Elemen baru ini tidak memiliki induk.
Return
FootnoteSection
— 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 terdapat dalam rentang teks yang dihapus dihapus dari elemen.
var body = DocumentApp.getActiveDocument().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);
Return
Text
— versi teks dari elemen saat ini
findElement(elementType)
Menelusuri konten elemen untuk turunan dari jenis yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
elementType | ElementType | jenis elemen yang akan dicari |
Return
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.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().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
Nama | Jenis | Deskripsi |
---|---|---|
elementType | ElementType | jenis elemen yang akan dicari |
from | RangeElement | hasil penelusuran untuk mencari |
Return
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.
Subset 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 terdapat dalam elemen saat ini.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
searchPattern | String | pola untuk mencari |
Return
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.
Subset 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 terdapat dalam elemen saat ini.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
searchPattern | String | pola untuk mencari |
from | RangeElement | hasil penelusuran untuk mencari |
Return
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
.
var body = DocumentApp.getActiveDocument().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]); }
Return
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.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. 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
Nama | Jenis | Deskripsi |
---|---|---|
childIndex | Integer | indeks elemen turunan untuk mengambil |
Return
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 untuk mengambil indeks |
Return
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
getNextSibling()
Mengambil elemen seinduk elemen berikutnya.
Saudara berikutnya memiliki induk yang sama dan mengikuti elemen saat ini.
Return
Element
— Elemen 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.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Return
Integer
— jumlah anak
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
getParagraphs()
Mengambil semua Paragraphs
yang terdapat dalam bagian tersebut (termasuk ListItems
).
Return
Paragraph[]
— paragraf bagian
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.
Return
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 seinduk elemen sebelumnya.
Saudara sebelumnya memiliki induk yang sama dan mendahului elemen saat ini.
Return
Element
— Elemen 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.
Return
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
.
Return
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 yang tepat dari elemen tertentu.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document 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.'); }
Return
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
insertParagraph(childIndex, paragraph)
Menyisipkan Paragraph
yang ditentukan pada indeks yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
childIndex | Integer | indeks untuk menyisipkan |
paragraph | Paragraph | paragraf untuk disisipkan |
Return
Paragraph
— paragraf yang disisipkan
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
insertParagraph(childIndex, text)
Membuat dan menyisipkan Paragraph
baru pada indeks yang ditentukan, yang berisi konten teks
yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
childIndex | Integer | indeks untuk menyisipkan |
text | String | konten teks paragraf |
Return
Paragraph
— paragraf 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
removeChild(child)
Menghapus elemen turunan yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
child | Element | elemen turunan yang akan dihapus |
Return
FootnoteSection
— 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
removeFromParent()
Menghapus elemen dari induknya.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Return
FootnoteSection
— 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 setiap garis miring terbalik di pola tersebut.
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.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
searchPattern | String | pola regex untuk mencari |
replacement | String | teks untuk digunakan sebagai pengganti |
Return
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 merupakan item dalam
enumerasi DocumentApp.Attribute
dan setiap nilai properti adalah nilai baru yang akan
diterapkan.
var body = DocumentApp.getActiveDocument().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
Nama | Jenis | Deskripsi |
---|---|---|
attributes | Object | Atribut elemen. |
Return
FootnoteSection
— 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
setText(text)
Menetapkan konten sebagai teks biasa.
Catatan: konten yang ada akan dihapus.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
text | String | konten teks baru |
Return
FootnoteSection
— 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 be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
textAlignment | TextAlignment | jenis perataan teks yang akan diterapkan |
Return
FootnoteSection
— 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