Class Paragraph

Paragraf

Elemen yang merepresentasikan paragraf. Paragraph dapat berisi elemen Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak, dan Text. Untuk informasi selengkapnya tentang struktur dokumen, lihat panduan untuk memperluas Google Dokumen.

Paragraphs tidak boleh berisi karakter baris baru. Karakter baris baru ("\n") dikonversi menjadi karakter jeda baris ("\r").

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

// Append a document header paragraph.
var header = body.appendParagraph("A Document");
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
var section = body.appendParagraph("Section 1");
section.setHeading(DocumentApp.ParagraphHeading.HEADING2);

// Append a regular paragraph.
body.appendParagraph("This is a typical paragraph.");

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addPositionedImage(image)PositionedImageMembuat dan menyisipkan PositionedImage baru dari blob gambar yang ditentukan.
appendHorizontalRule()HorizontalRuleMembuat dan menambahkan HorizontalRule baru.
appendInlineImage(image)InlineImageMembuat dan menambahkan InlineImage baru dari blob gambar yang ditentukan.
appendInlineImage(image)InlineImageMenambahkan InlineImage yang ditentukan.
appendPageBreak()PageBreakMembuat dan menambahkan PageBreak baru.
appendPageBreak(pageBreak)PageBreakMenambahkan PageBreak yang ditentukan.
appendText(text)TextMembuat dan menambahkan elemen Text baru dengan konten yang ditentukan.
appendText(text)TextMenambahkan elemen Text yang ditentukan.
clear()ParagraphMenghapus konten elemen.
copy()ParagraphMenampilkan salinan mendalam dan terpisah dari elemen saat ini.
editAsText()TextMendapatkan versi Text elemen saat ini, untuk pengeditan.
findElement(elementType)RangeElementMenelusuri konten elemen untuk turunan dari jenis yang ditentukan.
findElement(elementType, from)RangeElementMenelusuri konten elemen untuk turunan jenis yang ditentukan, dimulai 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, dimulai dari hasil penelusuran tertentu.
getAlignment()HorizontalAlignmentMengambil HorizontalAlignment.
getAttributes()ObjectMengambil atribut elemen.
getChild(childIndex)ElementMengambil elemen turunan di indeks turunan yang ditentukan.
getChildIndex(child)IntegerMengambil indeks turunan untuk elemen turunan yang ditentukan.
getHeading()ParagraphHeadingMengambil ParagraphHeading.
getIndentEnd()NumberMengambil indentasi akhir, dalam titik.
getIndentFirstLine()NumberMengambil indentasi baris pertama, dalam poin.
getIndentStart()NumberMengambil indentasi awal.
getLineSpacing()NumberMengambil spasi baris, dalam poin.
getLinkUrl()StringMengambil URL link.
getNextSibling()ElementMengambil elemen seinduk elemen berikutnya.
getNumChildren()IntegerMengambil jumlah turunan.
getParent()ContainerElementMengambil elemen induk elemen.
getPositionedImage(id)PositionedImageMendapatkan PositionedImage berdasarkan ID gambar.
getPositionedImages()PositionedImage[]Mendapatkan semua objek PositionedImage yang ditambatkan ke paragraf.
getPreviousSibling()ElementMengambil elemen seinduk elemen sebelumnya.
getSpacingAfter()NumberMengambil spasi setelah elemen, dalam titik.
getSpacingBefore()NumberMengambil spasi sebelum elemen, dalam titik.
getText()StringMengambil konten elemen sebagai string teks.
getTextAlignment()TextAlignmentMendapatkan perataan teks.
getType()ElementTypeMengambil ElementType elemen.
insertHorizontalRule(childIndex)HorizontalRuleMembuat dan menyisipkan HorizontalRule pada indeks yang ditentukan.
insertInlineImage(childIndex, image)InlineImageMembuat dan menyisipkan InlineImage baru dari blob gambar yang ditentukan, pada indeks yang ditentukan.
insertInlineImage(childIndex, image)InlineImageMenyisipkan InlineImage yang ditentukan pada indeks yang ditentukan.
insertPageBreak(childIndex)PageBreakMembuat dan menyisipkan PageBreak baru pada indeks yang ditentukan.
insertPageBreak(childIndex, pageBreak)PageBreakMenyisipkan PageBreak yang ditentukan pada indeks yang ditentukan.
insertText(childIndex, text)TextMembuat dan menyisipkan elemen teks baru pada indeks yang ditentukan.
insertText(childIndex, text)TextMenyisipkan elemen Text yang ditentukan pada indeks yang ditentukan, dengan konten teks yang ditentukan.
isAtDocumentEnd()BooleanMenentukan apakah elemen berada di akhir Document.
isLeftToRight()BooleanMengambil setelan kiri-ke-kanan.
merge()ParagraphMenggabungkan elemen dengan pasangan sebelumnya dari jenis yang sama.
removeChild(child)ParagraphMenghapus elemen turunan yang ditentukan.
removeFromParent()ParagraphMenghapus elemen dari induknya.
removePositionedImage(id)BooleanMenghapus PositionedImage berdasarkan ID gambar.
replaceText(searchPattern, replacement)ElementMengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi reguler.
setAlignment(alignment)ParagraphMenetapkan HorizontalAlignment.
setAttributes(attributes)ParagraphMenetapkan atribut elemen.
setHeading(heading)ParagraphMenetapkan ParagraphHeading.
setIndentEnd(indentEnd)ParagraphMenetapkan indentasi akhir, dalam titik.
setIndentFirstLine(indentFirstLine)ParagraphMenetapkan indentasi baris pertama, dalam poin.
setIndentStart(indentStart)ParagraphMenetapkan indentasi awal, dalam poin.
setLeftToRight(leftToRight)ParagraphMenetapkan setelan kiri-ke-kanan.
setLineSpacing(multiplier)ParagraphMenetapkan spasi baris, sebagai kuantitas yang menunjukkan jumlah baris yang akan digunakan untuk spasi.
setLinkUrl(url)ParagraphMenetapkan URL link.
setSpacingAfter(spacingAfter)ParagraphMenetapkan spasi setelah elemen, dalam titik.
setSpacingBefore(spacingBefore)ParagraphMenetapkan spasi sebelum elemen, dalam titik.
setText(text)voidMenetapkan konten paragraf sebagai teks.
setTextAlignment(textAlignment)ParagraphMenetapkan perataan teks.

Dokumentasi mendetail

addPositionedImage(image)

Membuat dan menyisipkan PositionedImage baru dari blob gambar yang ditentukan.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the specified image URL.
const image =
  UrlFetchApp.fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png');

// Adds the image to the document, anchored to the first paragraph.
paragraph.addPositionedImage(image);

Parameter

NamaTypeDeskripsi
imageBlobSourceData gambar.

Return

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.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a horizontal line under the first paragraph.
paragraph.appendHorizontalRule();

Return

HorizontalRule — Aturan horizontal yang 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.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the image from the specified image URL.
const image = UrlFetchApp
  .fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png');

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

Parameter

NamaTypeDeskripsi
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

appendInlineImage(image)

Menambahkan InlineImage yang ditentukan.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Makes a copy of the first image in the body.
const image = body.getImages()[0].copy();;

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

Parameter

NamaTypeDeskripsi
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

appendPageBreak()

Membuat dan menambahkan PageBreak baru.

Catatan: PageBreaks tidak boleh berada dalam TableCells. Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
paragraph.appendPageBreak();

Return

PageBreak — Elemen batas halaman yang 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 tidak dapat dimuat di dalam TableCells. Jika elemen saat ini ada dalam sel tabel, skrip akan menampilkan pengecualian.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
const pageBreak = paragraph.appendPageBreak();

// Makes a copy of the page break.
const newPageBreak = pageBreak.copy();

// Adds the copied page break to the paragraph.
paragraph.appendPageBreak(newPageBreak);

Parameter

NamaTypeDeskripsi
pageBreakPageBreakBatas halaman yang akan ditambahkan.

Return

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.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a string to the paragraph.
paragraph.appendText('This is a new sentence.');

Parameter

NamaTypeDeskripsi
textStringKonten teks.

Return

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

 // Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the text from the first paragraph in the body.
const paragraph1 = body.getParagraphs()[0];
const text = paragraph1.getText();

// Gets the third paragraph in the body.
const paragraph3 = body.getParagraphs()[2];

// Adds the text from the first paragraph to the third paragraph.
paragraph3.appendText(text);

Parameter

NamaTypeDeskripsi
textTextElemen teks yang akan ditambahkan.

Return

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

Menghapus konten elemen.

Return

Paragraph — elemen saat ini


copy()

Menampilkan salinan mendalam dan terpisah dari elemen saat ini.

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

Return

Paragraph — Salinan baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

editAsText()

Mendapatkan versi Text elemen saat ini, untuk pengeditan.

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 akan dihapus dari elemen tersebut.

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


findElement(elementType)

Menelusuri konten elemen untuk turunan dari jenis yang ditentukan.

Parameter

NamaTypeDeskripsi
elementTypeElementTypejenis elemen yang akan ditelusuri

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 jenis yang ditentukan, dimulai 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

NamaTypeDeskripsi
elementTypeElementTypejenis elemen yang akan ditelusuri
fromRangeElementhasil penelusuran untuk menelusuri dari

Return

RangeElement — hasil penelusuran yang menunjukkan posisi elemen penelusuran 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

findText(searchPattern)

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

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

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

Parameter

NamaTypeDeskripsi
searchPatternStringpola yang akan ditelusuri

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, dimulai dari hasil penelusuran tertentu.

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

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

Parameter

NamaTypeDeskripsi
searchPatternStringpola yang akan ditelusuri
fromRangeElementhasil penelusuran untuk menelusuri dari

Return

RangeElement — hasil penelusuran yang menunjukkan posisi teks penelusuran berikutnya, 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

getAlignment()

Mengambil HorizontalAlignment.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Sets the horizontal alignment to left for the first paragraph.
paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT);

// Gets the horizontal alignment of the first paragraph and logs it to the console.
console.log(paragraph.getAlignment().toString());

Return

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, dengan setiap nama properti sesuai dengan item di 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 di 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

NamaTypeDeskripsi
childIndexIntegerindeks elemen turunan yang akan diambil

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

NamaTypeDeskripsi
childElementelemen turunan yang akan diambil indeksnya

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

getHeading()

Mengambil ParagraphHeading.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Adds a paragraph to the body.
const paragraph = body.appendParagraph('Title heading');

// Sets the paragraph heading style to 'Title.'
paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE);

// Gets the heading style and logs it to the console.
console.log(paragraph.getHeading().toString());

Return

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

Return

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.

Return

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

getIndentStart()

Mengambil indentasi awal.

Return

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.

Return

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.

Return

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

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNextSibling()

Mengambil elemen seinduk elemen berikutnya.

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

Return

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

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

getPositionedImage(id)

Mendapatkan PositionedImage berdasarkan ID gambar.

Parameter

NamaTypeDeskripsi
idStringID gambar

Return

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.

Return

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

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

Return

Element — Elemen pasangan 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 titik.

Return

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

Return

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.

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 persis 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 pada indeks yang ditentukan.

Parameter

NamaTypeDeskripsi
childIndexIntegerindeks tempat menyisipkan elemen

Return

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 indeks yang ditentukan.

Parameter

NamaTypeDeskripsi
childIndexIntegerindeks tempat menyisipkan elemen
imageBlobSourcedata gambar

Return

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

NamaTypeDeskripsi
childIndexIntegerindeks tempat menyisipkan elemen
imageInlineImagedata gambar

Return

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 tidak boleh berada dalam TableCells. Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.

Parameter

NamaTypeDeskripsi
childIndexIntegerindeks tempat menyisipkan elemen

Return

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 tidak boleh berada dalam TableCells. Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.

Parameter

NamaTypeDeskripsi
childIndexIntegerindeks tempat menyisipkan elemen
pageBreakPageBreakjeda [p]untuk menyisipkan

Return

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

NamaTypeDeskripsi
childIndexIntegerindeks tempat menyisipkan elemen
textStringkonten teks

Return

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 ditentukan pada indeks yang ditentukan, dengan konten teks yang ditentukan.

Parameter

NamaTypeDeskripsi
childIndexIntegerindeks tempat menyisipkan elemen
textTextelemen teks yang akan disisipkan

Return

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.

Return

Boolean — Apakah elemen berada di akhir dokumen.

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.

Return

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 pasangan sebelumnya dari jenis yang sama.

Hanya elemen ElementType yang sama yang dapat digabungkan. Elemen turunan apa pun yang terdapat dalam elemen saat ini akan dipindahkan ke elemen seinduk sebelumnya.

Elemen saat ini akan dihapus dari dokumen.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
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();

Return

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

NamaTypeDeskripsi
childElementelemen turunan yang akan dihapus

Return

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

Paragraph — 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 berdasarkan ID gambar.

Parameter

NamaTypeDeskripsi
idStringID gambar

Return

Boolean — 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 reguler.

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

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

Pola ekspresi reguler yang diberikan 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

NamaTypeDeskripsi
searchPatternStringpola regex yang akan ditelusuri
replacementStringteks yang akan 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

setAlignment(alignment)

Menetapkan HorizontalAlignment.

Parameter

NamaTypeDeskripsi
alignmentHorizontalAlignmentperataan horizontal

Return

Paragraph — elemen saat ini

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setAttributes(attributes)

Menetapkan atribut elemen.

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

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

NamaTypeDeskripsi
attributesObjectAtribut elemen.

Return

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

NamaTypeDeskripsi
headingParagraphHeadingjudul

Return

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

NamaTypeDeskripsi
indentEndNumberindentasi akhir, dalam poin

Return

Paragraph — 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 poin.

Parameter

NamaTypeDeskripsi
indentFirstLineNumberindentasi baris pertama, dalam poin

Return

Paragraph — 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 poin.

Parameter

NamaTypeDeskripsi
indentStartNumberindentasi awal, dalam titik

Return

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

NamaTypeDeskripsi
leftToRightBooleanpengaturan kiri ke kanan

Return

Paragraph — 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 akan digunakan untuk spasi.

Parameter

NamaTypeDeskripsi
multiplierNumberjumlah baris

Return

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

NamaTypeDeskripsi
urlStringURL link

Return

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

NamaTypeDeskripsi
spacingAfterNumberspasi setelah elemen, dalam titik

Return

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

NamaTypeDeskripsi
spacingBeforeNumberspasi sebelum elemen, dalam titik

Return

Paragraph — 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 paragraf sebagai teks.

Catatan: konten yang ada akan dihapus.

Parameter

NamaTypeDeskripsi
textStringkonten 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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

NamaTypeDeskripsi
textAlignmentTextAlignmentjenis perataan teks yang akan diterapkan

Return

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