Halaman ini diterjemahkan oleh Cloud Translation API.

Class ListItem

Elemen yang mewakili item daftar. ListItem adalah Paragraph yang terkait dengan ID daftar. ListItem dapat berisi Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak, dan Text yang kurang penting. Untuk informasi lebih lanjut tentang struktur dokumen, lihat panduan untuk memperluas Google Dokumen.

ListItems tidak boleh berisi karakter baris baru. Karakter baris baru ("\n") adalah dikonversi menjadi karakter pemisah baris ("\t").

ListItems dengan ID daftar yang sama termasuk dalam daftar yang sama dan diberi nomor yang sesuai. ListItems untuk daftar tertentu tidak harus berdekatan dalam tab atau bahkan memiliki elemen induk yang sama. Dua item yang termasuk dalam daftar yang sama mungkin ada di mana pun di tab saat mempertahankan penomoran berurutan, seperti yang diilustrasikan dalam contoh berikut:

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

// Append a new list item to the body.
var item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([
  ['Cell 1', 'Cell 2']
]);

// Append a second list item with the same list ID. The two items are treated as the same list,
// despite not being consecutive.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
`addPositionedImage(image)`	`PositionedImage`	Membuat dan menyisipkan `PositionedImage` baru dari blob gambar yang ditentukan.
`appendHorizontalRule()`	`HorizontalRule`	Membuat dan menambahkan `HorizontalRule` baru.
`appendInlineImage(image)`	`InlineImage`	Membuat dan menambahkan `InlineImage` baru dari blob gambar yang ditentukan.
`appendInlineImage(image)`	`InlineImage`	Menambahkan `InlineImage` yang ditentukan.
`appendPageBreak()`	`PageBreak`	Membuat dan menambahkan `PageBreak` baru.
`appendPageBreak(pageBreak)`	`PageBreak`	Menambahkan `PageBreak` yang ditentukan.
`appendText(text)`	`Text`	Membuat dan menambahkan elemen `Text` baru dengan konten yang ditentukan.
`appendText(text)`	`Text`	Menambahkan elemen `Text` yang diberikan.
`clear()`	`ListItem`	Mengosongkan isi elemen.
`copy()`	`ListItem`	Menampilkan salinan mendalam yang 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 teks tertentu hasil penelusuran.
`getAlignment()`	`HorizontalAlignment`	Mengambil `HorizontalAlignment`.
`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.
`getGlyphType()`	`GlyphType`	Mengambil `GlyphType` item daftar.
`getHeading()`	`ParagraphHeading`	Mengambil `ParagraphHeading`.
`getIndentEnd()`	`Number`	Mengambil indentasi akhir, dalam poin.
`getIndentFirstLine()`	`Number`	Mengambil indentasi baris pertama, dalam poin.
`getIndentStart()`	`Number`	Mengambil indentasi awal.
`getLineSpacing()`	`Number`	Mengambil spasi baris, dalam poin.
`getLinkUrl()`	`String`	Mengambil URL link.
`getListId()`	`String`	Mengambil ID daftar.
`getNestingLevel()`	`Integer`	Mengambil tingkat penyusunan item daftar.
`getNextSibling()`	`Element`	Mengambil elemen yang seinduk berikutnya dari elemen.
`getNumChildren()`	`Integer`	Mengambil jumlah turunan.
`getParent()`	`ContainerElement`	Mengambil elemen induk elemen.
`getPositionedImage(id)`	`PositionedImage`	Mendapatkan `PositionedImage` melalui ID gambar.
`getPositionedImages()`	`PositionedImage[]`	Mendapatkan semua objek `PositionedImage` yang ditambatkan ke paragraf.
`getPreviousSibling()`	`Element`	Mengambil elemen yang seinduk sebelumnya dari elemen.
`getSpacingAfter()`	`Number`	Mengambil spasi setelah elemen, dalam poin.
`getSpacingBefore()`	`Number`	Mengambil spasi sebelum elemen, dalam poin.
`getText()`	`String`	Mengambil konten elemen sebagai string teks.
`getTextAlignment()`	`TextAlignment`	Mendapatkan perataan teks.
`getType()`	`ElementType`	Mengambil `ElementType` elemen.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Membuat dan menyisipkan `HorizontalRule` pada indeks yang ditentukan.
`insertInlineImage(childIndex, image)`	`InlineImage`	Membuat dan menyisipkan `InlineImage` baru dari blob gambar yang ditentukan, pada waktu yang ditentukan Google Cloud.
`insertInlineImage(childIndex, image)`	`InlineImage`	Menyisipkan `InlineImage` yang ditentukan pada indeks yang ditentukan.
`insertPageBreak(childIndex)`	`PageBreak`	Membuat dan menyisipkan `PageBreak` baru pada indeks yang ditentukan.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Menyisipkan `PageBreak` yang ditentukan pada indeks yang ditentukan.
`insertText(childIndex, text)`	`Text`	Membuat dan menyisipkan elemen teks baru pada indeks yang ditentukan.
`insertText(childIndex, text)`	`Text`	Menyisipkan elemen `Text` yang diberikan pada indeks yang ditentukan, dengan teks yang ditentukan konten.
`isAtDocumentEnd()`	`Boolean`	Menentukan apakah elemen berada di akhir `Document`.
`isLeftToRight()`	`Boolean`	Mengambil setelan kiri-ke-kanan.
`merge()`	`ListItem`	Menggabungkan elemen dengan yang seinduk sebelumnya dari jenis yang sama.
`removeChild(child)`	`ListItem`	Menghapus elemen turunan yang ditentukan.
`removeFromParent()`	`ListItem`	Menghapus elemen dari induknya.
`removePositionedImage(id)`	`Boolean`	Menghapus `PositionedImage` menurut ID gambar.
`replaceText(searchPattern, replacement)`	`Element`	Mengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi.
`setAlignment(alignment)`	`ListItem`	Menetapkan `HorizontalAlignment`.
`setAttributes(attributes)`	`ListItem`	Menetapkan atribut elemen.
`setGlyphType(glyphType)`	`ListItem`	Menetapkan `GlyphType` item daftar.
`setHeading(heading)`	`ListItem`	Menetapkan `ParagraphHeading`.
`setIndentEnd(indentEnd)`	`ListItem`	Menetapkan indentasi akhir, dalam titik.
`setIndentFirstLine(indentFirstLine)`	`ListItem`	Menetapkan indentasi baris pertama, dalam titik.
`setIndentStart(indentStart)`	`ListItem`	Menetapkan indentasi awal, dalam titik.
`setLeftToRight(leftToRight)`	`ListItem`	Menetapkan setelan kiri-ke-kanan.
`setLineSpacing(multiplier)`	`ListItem`	Menetapkan spasi baris, sebagai kuantitas yang menunjukkan jumlah baris yang digunakan untuk spasi.
`setLinkUrl(url)`	`ListItem`	Menetapkan URL link.
`setListId(listItem)`	`ListItem`	Menetapkan ID daftar.
`setNestingLevel(nestingLevel)`	`ListItem`	Menetapkan tingkat bertingkat item daftar.
`setSpacingAfter(spacingAfter)`	`ListItem`	Menetapkan spasi setelah elemen, dalam titik.
`setSpacingBefore(spacingBefore)`	`ListItem`	Menetapkan spasi sebelum elemen, dalam titik.
`setText(text)`	`void`	Menetapkan konten item daftar sebagai teks.
`setTextAlignment(textAlignment)`	`ListItem`	Menetapkan perataan teks.

Dokumentasi mendetail

`addPositionedImage(image)`

Membuat dan menyisipkan PositionedImage baru dari blob gambar yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`image`	`BlobSource`	data gambar

Pulang pergi

PositionedImage — gambar baru yang diposisikan

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

`appendHorizontalRule()`

Membuat dan menambahkan HorizontalRule baru.

Pulang pergi

HorizontalRule — aturan 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

`appendInlineImage(image)`

Membuat dan menambahkan InlineImage baru dari blob gambar yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`image`	`BlobSource`	data gambar

Pulang pergi

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

`appendInlineImage(image)`

Menambahkan InlineImage yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`image`	`InlineImage`	data gambar

Pulang pergi

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

`appendPageBreak()`

Membuat dan menambahkan PageBreak baru.

Catatan: PageBreaks mungkin tidak dimuat dalam TableCells. Jika elemen saat ini dimuat dalam sel tabel, pengecualian akan dilempar.

Pulang pergi

PageBreak — elemen 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.

Catatan: PageBreaks mungkin tidak dimuat dalam TableCells. Jika elemen saat ini dimuat dalam sel tabel, pengecualian akan dilempar.

Parameter

Nama	Jenis	Deskripsi
`pageBreak`	`PageBreak`	batas halaman untuk menambahkan

Pulang pergi

PageBreak — elemen 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

`appendText(text)`

Membuat dan menambahkan elemen Text baru dengan konten yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`text`	`String`	isi teks

Pulang pergi

Text — elemen teks 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

`appendText(text)`

Menambahkan elemen Text yang diberikan.

Parameter

Nama	Jenis	Deskripsi
`text`	`Text`	elemen teks yang akan ditambahkan

Pulang pergi

Text — elemen teks 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()`

Mengosongkan isi elemen.

Pulang pergi

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

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

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

Nama	Jenis	Deskripsi
`elementType`	`ElementType`	Jenis elemen yang akan ditelusuri.
`from`	`RangeElement`	Hasil 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

Nama	Jenis	Deskripsi
`searchPattern`	`String`	pola 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

Nama	Jenis	Deskripsi
`searchPattern`	`String`	pola untuk mencari
`from`	`RangeElement`	hasil 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

`getAlignment()`

Mengambil HorizontalAlignment.

Pulang pergi

HorizontalAlignment — perataan

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

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

`getGlyphType()`

Mengambil GlyphType item daftar.

Pulang pergi

GlyphType — jenis glyph

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

`getHeading()`

Mengambil ParagraphHeading.

Pulang pergi

ParagraphHeading — judul

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

`getIndentEnd()`

Mengambil indentasi akhir, dalam poin.

Pulang pergi

Number — indentasi akhir, 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

`getIndentFirstLine()`

Mengambil indentasi baris pertama, dalam poin.

Pulang pergi

Number — indentasi baris pertama, 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

`getIndentStart()`

Mengambil indentasi awal.

Pulang pergi

Number — indentasi awal

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

`getLineSpacing()`

Mengambil spasi baris, dalam poin.

Pulang pergi

Number — spasi baris, dalam titik

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

`getListId()`

Mengambil ID daftar.

Pulang pergi

String — ID daftar

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

`getNestingLevel()`

Mengambil tingkat penyusunan item daftar.

Secara default, item daftar memiliki tingkat bertingkat nol. Tingkat bertingkat menentukan glyph yang digunakan oleh item daftar.

Pulang pergi

Integer — tingkat bertingkat

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

`getPositionedImage(id)`

Mendapatkan PositionedImage melalui ID gambar.

Parameter

Nama	Jenis	Deskripsi
`id`	`String`	id gambar

Pulang pergi

PositionedImage — gambar yang diposisikan

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

`getPositionedImages()`

Mendapatkan semua objek PositionedImage yang ditambatkan ke paragraf.

Pulang pergi

PositionedImage[] — daftar gambar yang diposisikan

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

`getSpacingAfter()`

Mengambil spasi setelah elemen, dalam poin.

Pulang pergi

Number — spasi setelah elemen, dalam titik

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

`getSpacingBefore()`

Mengambil spasi sebelum elemen, dalam poin.

Pulang pergi

Number — spasi sebelum elemen, dalam titik

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

`insertHorizontalRule(childIndex)`

Membuat dan menyisipkan HorizontalRule pada indeks yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks tempat menyisipkan elemen

Pulang pergi

HorizontalRule — elemen aturan 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

`insertInlineImage(childIndex, image)`

Membuat dan menyisipkan InlineImage baru dari blob gambar yang ditentukan, pada waktu yang ditentukan Google Cloud.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks tempat menyisipkan elemen
`image`	`BlobSource`	data gambar

Pulang pergi

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

`insertInlineImage(childIndex, image)`

Menyisipkan InlineImage yang ditentukan pada indeks yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks tempat menyisipkan elemen
`image`	`InlineImage`	data gambar

Pulang pergi

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

`insertPageBreak(childIndex)`

Membuat dan menyisipkan PageBreak baru pada indeks yang ditentukan.

Catatan: PageBreaks mungkin tidak dimuat dalam TableCells. Jika elemen saat ini dimuat dalam sel tabel, pengecualian akan dilempar.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks tempat menyisipkan elemen

Pulang pergi

PageBreak — elemen 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.

Catatan: PageBreaks mungkin tidak dimuat dalam TableCells. Jika elemen saat ini dimuat dalam sel tabel, pengecualian akan dilempar.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks tempat menyisipkan elemen
`pageBreak`	`PageBreak`	p[age jeda untuk menyisipkan

Pulang pergi

PageBreak — elemen 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

`insertText(childIndex, text)`

Membuat dan menyisipkan elemen teks baru pada indeks yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks tempat menyisipkan elemen
`text`	`String`	isi teks

Pulang pergi

Text — elemen teks 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

`insertText(childIndex, text)`

Menyisipkan elemen Text yang diberikan pada indeks yang ditentukan, dengan teks yang ditentukan konten.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks tempat menyisipkan elemen
`text`	`Text`	elemen teks yang akan disisipkan

Pulang pergi

Text — elemen teks 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

`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

`isLeftToRight()`

Mengambil setelan kiri-ke-kanan.

Pulang pergi

Boolean — setelan kiri-ke-kanan

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

`merge()`

Menggabungkan elemen dengan yang seinduk sebelumnya dari jenis yang sama.

Hanya elemen ElementType yang sama yang dapat digabungkan. Setiap elemen turunan yang terkandung dalam elemen saat ini dipindahkan ke elemen seinduk sebelumnya.

Elemen saat ini akan dihapus dari dokumen.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

Pulang pergi

ListItem — Elemen yang digabungkan.

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

Pulang pergi

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

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

`removePositionedImage(id)`

Menghapus PositionedImage menurut ID gambar.

Parameter

Nama	Jenis	Deskripsi
`id`	`String`

Pulang pergi

Boolean — terlepas dari apakah gambar yang ditentukan dihapus atau tidak

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

Nama	Jenis	Deskripsi
`searchPattern`	`String`	pola regex untuk mencari
`replacement`	`String`	teks 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

`setAlignment(alignment)`

Menetapkan HorizontalAlignment.

Parameter

Nama	Jenis	Deskripsi
`alignment`	`HorizontalAlignment`	perataan horizontal

Pulang pergi

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

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

Pulang pergi

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

`setGlyphType(glyphType)`

Menetapkan GlyphType item daftar.

Parameter

Nama	Jenis	Deskripsi
`glyphType`	`GlyphType`	jenis glyph

Pulang pergi

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

`setHeading(heading)`

Menetapkan ParagraphHeading.

Parameter

Nama	Jenis	Deskripsi
`heading`	`ParagraphHeading`	judul

Pulang pergi

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

`setIndentEnd(indentEnd)`

Menetapkan indentasi akhir, dalam titik.

Parameter

Nama	Jenis	Deskripsi
`indentEnd`	`Number`	indentasi akhir, dalam poin

Pulang pergi

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

`setIndentFirstLine(indentFirstLine)`

Menetapkan indentasi baris pertama, dalam titik.

Parameter

Nama	Jenis	Deskripsi
`indentFirstLine`	`Number`	indentasi baris pertama, menggunakan poin

Pulang pergi

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

`setIndentStart(indentStart)`

Menetapkan indentasi awal, dalam titik.

Parameter

Nama	Jenis	Deskripsi
`indentStart`	`Number`	indentasi awal, dalam poin

Pulang pergi

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

`setLeftToRight(leftToRight)`

Menetapkan setelan kiri-ke-kanan.

Parameter

Nama	Jenis	Deskripsi
`leftToRight`	`Boolean`	pengaturan kiri-ke-kanan

Pulang pergi

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

`setLineSpacing(multiplier)`

Menetapkan spasi baris, sebagai kuantitas yang menunjukkan jumlah baris yang digunakan untuk spasi.

Parameter

Nama	Jenis	Deskripsi
`multiplier`	`Number`	jumlah garis

Pulang pergi

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

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

`setListId(listItem)`

Menetapkan ID daftar.

ID daftar ditetapkan ke nilai yang sama untuk ListItem yang ditentukan. Kedua ListItems akan diperlakukan sebagai anggota daftar yang sama.

Parameter

Nama	Jenis	Deskripsi
`listItem`	`ListItem`	item daftar yang ID daftarnya akan digunakan

Pulang pergi

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

`setNestingLevel(nestingLevel)`

Menetapkan tingkat bertingkat item daftar.

Secara default, item daftar memiliki tingkat bertingkat nol. Tingkat bertingkat menentukan glyph yang digunakan oleh item daftar.

Parameter

Nama	Jenis	Deskripsi
`nestingLevel`	`Integer`	{i>nesting level<i}

Pulang pergi

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

`setSpacingAfter(spacingAfter)`

Menetapkan spasi setelah elemen, dalam titik.

Parameter

Nama	Jenis	Deskripsi
`spacingAfter`	`Number`	jarak setelah elemen, dalam poin

Pulang pergi

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

`setSpacingBefore(spacingBefore)`

Menetapkan spasi sebelum elemen, dalam titik.

Parameter

Nama	Jenis	Deskripsi
`spacingBefore`	`Number`	jarak sebelum elemen, dalam poin

Pulang pergi

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

Catatan: konten yang ada akan dihapus.

Parameter

Nama	Jenis	Deskripsi
`text`	`String`	konten teks 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

`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

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

Pulang pergi

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