Class Body

Body

Elemen yang mewakili isi dokumen. Body dapat berisi elemen ListItem, Paragraph, Table, dan TableOfContents. Untuk mengetahui informasi selengkapnya tentang struktur dokumen, lihat panduan memperluas Google Dokumen.

Body biasanya berisi konten dokumen lengkap kecuali untuk elemen HeaderSection, FooterSection, dan FootnoteSection.

var doc = DocumentApp.getActiveDocument();
var body = doc.getBody();

// Append a paragraph and a page break to the document body section directly.
body.appendParagraph("A paragraph.");
body.appendPageBreak();

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
appendHorizontalRule()HorizontalRuleMembuat dan menambahkan HorizontalRule baru.
appendImage(image)InlineImageMembuat dan menambahkan InlineImage baru dari blob gambar yang ditentukan.
appendImage(image)InlineImageMenambahkan InlineImage yang ditentukan.
appendListItem(listItem)ListItemMenambahkan ListItem yang ditentukan.
appendListItem(text)ListItemMembuat dan menambahkan ListItem baru yang berisi konten teks yang ditentukan.
appendPageBreak()PageBreakMembuat dan menambahkan PageBreak baru.
appendPageBreak(pageBreak)PageBreakMenambahkan PageBreak yang ditentukan.
appendParagraph(paragraph)ParagraphMenambahkan Paragraph yang ditentukan.
appendParagraph(text)ParagraphMembuat dan menambahkan Paragraph baru yang berisi konten teks yang ditentukan.
appendTable()TableMembuat dan menambahkan Table baru.
appendTable(cells)TableMenambahkan Table baru yang berisi TableCell untuk setiap nilai string yang ditentukan.
appendTable(table)TableMenambahkan Table yang ditentukan.
clear()BodyMenghapus konten elemen.
copy()BodyMenampilkan salinan mendalam dan 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 hasil penelusuran tertentu.
getAttributes()ObjectMengambil atribut elemen.
getChild(childIndex)ElementMengambil elemen turunan pada indeks turunan yang ditentukan.
getChildIndex(child)IntegerMengambil indeks turunan untuk elemen turunan yang ditentukan.
getHeadingAttributes(paragraphHeading)ObjectMengambil kumpulan atribut untuk ParagraphHeading yang disediakan.
getImages()InlineImage[]Mengambil semua InlineImages yang terdapat di bagian tersebut.
getListItems()ListItem[]Mengambil semua ListItems yang terdapat di bagian tersebut.
getMarginBottom()NumberMengambil margin bawah, dalam poin.
getMarginLeft()NumberMengambil margin kiri, dalam poin.
getMarginRight()NumberMengambil margin kanan.
getMarginTop()NumberMengambil margin atas.
getNumChildren()IntegerMengambil jumlah turunan.
getPageHeight()NumberMengambil tinggi halaman, dalam poin.
getPageWidth()NumberMengambil lebar halaman, dalam poin.
getParagraphs()Paragraph[]Mengambil semua Paragraphs yang terdapat dalam bagian tersebut (termasuk ListItems).
getParent()ContainerElementMengambil elemen induk elemen.
getTables()Table[]Mengambil semua Tables yang terdapat di bagian tersebut.
getText()StringMengambil konten elemen sebagai string teks.
getTextAlignment()TextAlignmentMendapatkan perataan teks.
getType()ElementTypeMengambil ElementType elemen.
insertHorizontalRule(childIndex)HorizontalRuleMembuat dan menyisipkan HorizontalRule baru pada indeks yang ditentukan.
insertImage(childIndex, image)InlineImageMembuat dan menyisipkan InlineImage dari blob gambar yang ditentukan, pada indeks yang ditentukan.
insertImage(childIndex, image)InlineImageMenyisipkan InlineImage yang ditentukan pada indeks yang ditentukan.
insertListItem(childIndex, listItem)ListItemMenyisipkan ListItem yang ditentukan pada indeks yang ditentukan.
insertListItem(childIndex, text)ListItemMembuat dan menyisipkan ListItem baru pada indeks yang ditentukan, yang berisi konten teks yang ditentukan.
insertPageBreak(childIndex)PageBreakMembuat dan menyisipkan PageBreak baru pada indeks yang ditentukan.
insertPageBreak(childIndex, pageBreak)PageBreakMenyisipkan PageBreak yang ditentukan pada indeks yang ditentukan.
insertParagraph(childIndex, paragraph)ParagraphMenyisipkan Paragraph yang ditentukan pada indeks yang ditentukan.
insertParagraph(childIndex, text)ParagraphMembuat dan menyisipkan Paragraph baru pada indeks yang ditentukan, yang berisi konten teks yang ditentukan.
insertTable(childIndex)TableMembuat dan menyisipkan Table baru pada indeks yang ditentukan.
insertTable(childIndex, cells)TableMembuat dan menyisipkan Table baru yang berisi sel yang ditentukan, pada indeks yang ditentukan.
insertTable(childIndex, table)TableMenyisipkan Table yang ditentukan pada indeks yang ditentukan.
removeChild(child)BodyMenghapus elemen turunan yang ditentukan.
replaceText(searchPattern, replacement)ElementMengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi reguler.
setAttributes(attributes)BodyMenetapkan atribut elemen.
setHeadingAttributes(paragraphHeading, attributes)BodyMenetapkan atribut untuk ParagraphHeading yang disediakan.
setMarginBottom(marginBottom)BodyMenetapkan margin bawah, dalam poin.
setMarginLeft(marginLeft)BodyMenetapkan margin kiri, dalam poin.
setMarginRight(marginRight)BodyMenetapkan margin kanan, dalam poin.
setMarginTop(marginTop)BodyMenetapkan margin atas.
setPageHeight(pageHeight)BodyMenetapkan tinggi halaman, dalam poin.
setPageWidth(pageWidth)BodyMenetapkan lebar halaman, dalam poin.
setText(text)BodyMenetapkan konten sebagai teks biasa.
setTextAlignment(textAlignment)BodyMenetapkan perataan teks.

Dokumentasi mendetail

appendHorizontalRule()

Membuat dan menambahkan HorizontalRule baru.

HorizontalRule akan berada dalam Paragraph baru.

Return

HorizontalRule — garis horizontal 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

appendImage(image)

Membuat dan menambahkan InlineImage baru dari blob gambar yang ditentukan.

Gambar akan dimuat dalam Paragraph baru.

Parameter

NamaJenisDeskripsi
imageBlobSourcedata gambar

Return

InlineImage — gambar 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

appendImage(image)

Menambahkan InlineImage yang ditentukan.

InlineImage akan berada dalam Paragraph baru.

Gunakan versi appendImage ini saat menambahkan salinan InlineImage yang sudah ada.

Parameter

NamaJenisDeskripsi
imageInlineImagedata gambar

Return

InlineImage — gambar 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

appendListItem(listItem)

Menambahkan ListItem yang ditentukan.

Gunakan versi appendListItem ini saat menambahkan salinan ListItem yang sudah ada.

Parameter

NamaJenisDeskripsi
listItemListItemitem daftar yang akan ditambahkan

Return

ListItem — item daftar 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

appendListItem(text)

Membuat dan menambahkan ListItem baru yang berisi konten teks yang ditentukan.

Item daftar berurutan ditambahkan sebagai bagian dari daftar yang sama.

Parameter

NamaJenisDeskripsi
textStringkonten teks item daftar

Return

ListItem — item daftar 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

appendPageBreak()

Membuat dan menambahkan PageBreak baru.

PageBreak akan berada dalam Paragraph baru.

Return

PageBreak — batas halaman 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

appendPageBreak(pageBreak)

Menambahkan PageBreak yang ditentukan.

PageBreak akan berada dalam Paragraph baru.

Gunakan versi appendPageBreak ini saat menambahkan salinan PageBreak yang sudah ada.

Parameter

NamaJenisDeskripsi
pageBreakPageBreakbatas halaman untuk ditambahkan

Return

PageBreak — batas halaman 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(paragraph)

Menambahkan Paragraph yang ditentukan.

Gunakan versi appendParagraph ini saat menambahkan salinan Paragraph yang sudah ada.

Parameter

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

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

appendTable()

Membuat dan menambahkan Table baru.

Metode ini juga akan menambahkan paragraf kosong setelah tabel, karena dokumen Google Dokumen tidak dapat diakhiri dengan tabel.

Return

Table — tabel 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

appendTable(cells)

Menambahkan Table baru yang berisi TableCell untuk setiap nilai string yang ditentukan.

Metode ini juga akan menambahkan paragraf kosong setelah tabel, karena dokumen Google Dokumen tidak dapat diakhiri dengan tabel.

Parameter

NamaJenisDeskripsi
cellsString[][]isi teks dari sel tabel untuk ditambahkan ke tabel baru

Return

Table — tabel 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

appendTable(table)

Menambahkan Table yang ditentukan.

Gunakan versi appendTable ini saat menambahkan salinan Table yang sudah ada. Metode ini juga akan menambahkan paragraf kosong setelah tabel, karena dokumen Google Dokumen tidak dapat diakhiri dengan tabel.

Parameter

NamaJenisDeskripsi
tableTabletabel untuk menambahkan

Return

Table — tabel 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

clear()

Menghapus konten elemen.

Return

Body — elemen saat ini


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

Body — 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

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

NamaJenisDeskripsi
elementTypeElementTypejenis elemen yang akan dicari
fromRangeElementhasil 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

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

NamaJenisDeskripsi
searchPatternStringpola untuk mencari
fromRangeElementhasil 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

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

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

getHeadingAttributes(paragraphHeading)

Mengambil kumpulan atribut untuk ParagraphHeading yang disediakan.

Parameter

NamaJenisDeskripsi
paragraphHeadingParagraphHeadingjudul yang atributnya akan diambil

Return

Object — peta atribut dan nilainya 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

getImages()

Mengambil semua InlineImages yang terdapat di bagian tersebut.

Return

InlineImage[] — gambar 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

getListItems()

Mengambil semua ListItems yang terdapat di bagian tersebut.

Return

ListItem[] — item daftar 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

getMarginBottom()

Mengambil margin bawah, dalam poin.

Return

Number — margin bawah, dalam poin

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

getMarginLeft()

Mengambil margin kiri, dalam poin.

Return

Number — margin kiri, dalam poin

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

getMarginRight()

Mengambil margin kanan.

Return

Number — margin kanan, dalam poin

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

getMarginTop()

Mengambil margin atas.

Return

Number — margin atas, dalam poin

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

getPageHeight()

Mengambil tinggi halaman, dalam poin.

Return

Number — tinggi halaman, dalam poin

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

getPageWidth()

Mengambil lebar halaman, dalam poin.

Return

Number — lebar halaman, dalam poin

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

getTables()

Mengambil semua Tables yang terdapat di bagian tersebut.

Return

Table[] — tabel 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

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

insertHorizontalRule(childIndex)

Membuat dan menyisipkan HorizontalRule baru pada indeks yang ditentukan.

HorizontalRule akan berada dalam Paragraph baru.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan elemen

Return

HorizontalRule — garis horizontal 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

insertImage(childIndex, image)

Membuat dan menyisipkan InlineImage dari blob gambar yang ditentukan, pada indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan elemen
imageBlobSourcedata gambar

Return

InlineImage — gambar inline 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

insertImage(childIndex, image)

Menyisipkan InlineImage yang ditentukan pada indeks yang ditentukan.

Gambar akan dimuat dalam Paragraph baru.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan elemen
imageInlineImagegambar untuk disisipkan

Return

InlineImage — gambar inline 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

insertListItem(childIndex, listItem)

Menyisipkan ListItem yang ditentukan pada indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan
listItemListItemitem daftar yang akan disisipkan

Return

ListItem — item daftar 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

insertListItem(childIndex, text)

Membuat dan menyisipkan ListItem baru pada indeks yang ditentukan, yang berisi konten teks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan
textStringkonten teks item daftar

Return

ListItem — item daftar 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

insertPageBreak(childIndex)

Membuat dan menyisipkan PageBreak baru pada indeks yang ditentukan.

PageBreak akan berada dalam Paragraph baru.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan elemen

Return

PageBreak — batas halaman 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

insertPageBreak(childIndex, pageBreak)

Menyisipkan PageBreak yang ditentukan pada indeks yang ditentukan.

PageBreak akan berada dalam Paragraph baru.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan elemen
pageBreakPageBreakp[age break [batas usia] untuk menyisipkan

Return

PageBreak — batas halaman 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, paragraph)

Menyisipkan Paragraph yang ditentukan pada indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan
paragraphParagraphparagraf 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

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan
textStringkonten 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

insertTable(childIndex)

Membuat dan menyisipkan Table baru pada indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan

Return

Table — tabel 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

insertTable(childIndex, cells)

Membuat dan menyisipkan Table baru yang berisi sel yang ditentukan, pada indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan
cellsString[][]isi teks dari sel tabel untuk ditambahkan ke tabel baru

Return

Table — tabel 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

insertTable(childIndex, table)

Menyisipkan Table yang ditentukan pada indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks untuk menyisipkan
tableTabletabel untuk menyisipkan

Return

Table — tabel 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

removeChild(child)

Menghapus elemen turunan yang ditentukan.

Parameter

NamaJenisDeskripsi
childElementelemen turunan yang akan dihapus

Return

Body — 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

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

NamaJenisDeskripsi
searchPatternStringpola regex untuk mencari
replacementStringteks 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

NamaJenisDeskripsi
attributesObjectAtribut elemen.

Return

Body — 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

setHeadingAttributes(paragraphHeading, attributes)

Menetapkan atribut untuk ParagraphHeading yang disediakan.

Parameter

NamaJenisDeskripsi
paragraphHeadingParagraphHeadingjudul yang atributnya akan ditetapkan
attributesObjectpeta atribut dan nilai untuk menetapkannya

Return

Body — 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

setMarginBottom(marginBottom)

Menetapkan margin bawah, dalam poin.

Parameter

NamaJenisDeskripsi
marginBottomNumbermargin bawah, dalam poin

Return

Body — 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

setMarginLeft(marginLeft)

Menetapkan margin kiri, dalam poin.

Parameter

NamaJenisDeskripsi
marginLeftNumbermargin kiri, dalam poin

Return

Body — 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

setMarginRight(marginRight)

Menetapkan margin kanan, dalam poin.

Parameter

NamaJenisDeskripsi
marginRightNumbermargin kanan

Return

Body — 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

setMarginTop(marginTop)

Menetapkan margin atas.

Parameter

NamaJenisDeskripsi
marginTopNumbermargin atas, dalam poin

Return

Body — 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

setPageHeight(pageHeight)

Menetapkan tinggi halaman, dalam poin.

Parameter

NamaJenisDeskripsi
pageHeightNumbertinggi halaman, dalam poin

Return

Body — 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

setPageWidth(pageWidth)

Menetapkan lebar halaman, dalam poin.

Parameter

NamaJenisDeskripsi
pageWidthNumberlebar halaman, dalam poin

Return

Body — 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

NamaJenisDeskripsi
textStringkonten teks baru

Return

Body — 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

NamaJenisDeskripsi
textAlignmentTextAlignmentjenis perataan teks yang akan diterapkan

Return

Body — 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

Metode yang tidak digunakan lagi