Class Paragraph

Paragraf

Elemen yang merepresentasikan paragraf. Paragraph dapat berisi elemen Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak, dan Text. Untuk mengetahui 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").

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

// Append a tab header paragraph.
const header = body.appendParagraph('A Document');
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
const 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 diberikan.
appendPageBreak()PageBreakMembuat dan menambahkan PageBreak baru.
appendPageBreak(pageBreak)PageBreakMenambahkan PageBreak yang diberikan.
appendText(text)TextMembuat dan menambahkan elemen Text baru dengan konten yang ditentukan.
appendText(text)TextMenambahkan elemen Text yang diberikan.
clear()ParagraphMenghapus konten elemen.
copy()ParagraphMenampilkan salinan mendalam yang terlepas dari elemen saat ini.
editAsText()TextMendapatkan versi Text dari elemen saat ini, untuk pengeditan.
findElement(elementType)RangeElement|nullMenelusuri konten elemen untuk menemukan turunan dari jenis yang ditentukan.
findElement(elementType, from)RangeElement|nullMenelusuri konten elemen untuk menemukan keturunan dari jenis yang ditentukan, dimulai dari RangeElement yang ditentukan.
findText(searchPattern)RangeElement|nullMenelusuri konten elemen untuk pola teks yang ditentukan menggunakan ekspresi reguler.
findText(searchPattern, from)RangeElement|nullMenelusuri konten elemen untuk menemukan pola teks yang ditentukan, dimulai dari hasil penelusuran tertentu.
getAlignment()HorizontalAlignment|nullMengambil HorizontalAlignment.
getAttributes()ObjectMengambil atribut elemen.
getChild(childIndex)ElementMengambil elemen turunan pada indeks turunan yang ditentukan.
getChildIndex(child)IntegerMengambil indeks turunan untuk elemen turunan yang ditentukan.
getHeading()ParagraphHeading|nullMengambil ParagraphHeading.
getIndentEnd()Number|nullMengambil indentasi akhir, dalam poin.
getIndentFirstLine()Number|nullMengambil indentasi baris pertama, dalam poin.
getIndentStart()Number|nullMengambil indentasi awal.
getLineSpacing()Number|nullMengambil jarak antarbaris, dalam poin.
getLinkUrl()String|nullMengambil URL link.
getNextSibling()Element|nullMengambil elemen pasangan berikutnya dari elemen.
getNumChildren()IntegerMengambil jumlah turunan.
getParent()ContainerElement|nullMengambil elemen induk elemen.
getPositionedImage(id)PositionedImageMendapatkan PositionedImage berdasarkan ID gambar.
getPositionedImages()PositionedImage[]Mendapatkan semua objek PositionedImage yang ditambatkan ke paragraf.
getPreviousSibling()Element|nullMengambil elemen saudara sebelumnya dari elemen.
getSpacingAfter()Number|nullMengambil jarak setelah elemen, dalam poin.
getSpacingBefore()Number|nullMengambil spasi sebelum elemen, dalam poin.
getText()StringMengambil konten elemen sebagai string teks.
getTextAlignment()TextAlignment|nullMendapatkan 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 diberikan pada indeks yang ditentukan.
insertPageBreak(childIndex)PageBreakMembuat dan menyisipkan PageBreak baru pada indeks yang ditentukan.
insertPageBreak(childIndex, pageBreak)PageBreakMenyisipkan PageBreak yang diberikan pada indeks yang ditentukan.
insertText(childIndex, text)TextMembuat dan menyisipkan elemen teks baru pada indeks yang ditentukan.
insertText(childIndex, text)TextMenyisipkan elemen Text yang diberikan pada indeks yang ditentukan, dengan konten teks yang ditentukan.
isAtDocumentEnd()BooleanMenentukan apakah elemen berada di akhir Document.
isLeftToRight()Boolean|nullMengambil setelan kiri-ke-kanan.
merge()Paragraph|nullMenggabungkan elemen dengan elemen saudara sebelumnya dengan jenis yang sama.
removeChild(child)ParagraphMenghapus elemen turunan yang ditentukan.
removeFromParent()Paragraph|nullMenghapus 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 poin.
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 jarak antar-baris, sebagai kuantitas yang menunjukkan jumlah baris yang akan digunakan untuk jarak.
setLinkUrl(url)ParagraphMenetapkan URL link.
setSpacingAfter(spacingAfter)ParagraphMenetapkan spasi setelah elemen, dalam poin.
setSpacingBefore(spacingBefore)ParagraphMenetapkan jarak sebelum elemen, dalam poin.
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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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 tab, anchored to the first paragraph.
paragraph.addPositionedImage(image);

Parameter

NamaJenisDeskripsi
imageBlobSourceData gambar.

Pulang pergi

PositionedImage — Gambar yang diposisikan 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

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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

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

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

Pulang pergi

HorizontalRule — Penggaris 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.

// 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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

NamaJenisDeskripsi
imageBlobSourceData 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 diberikan.

// 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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

NamaJenisDeskripsi
imageInlineImageData 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 ada dalam TableCells. Jika elemen saat ini ada 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

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

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

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

Catatan: PageBreaks tidak dapat berada dalam TableCells. Jika elemen saat ini ada di 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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

NamaJenisDeskripsi
pageBreakPageBreakPemisah halaman yang akan ditambahkan.

Pulang pergi

PageBreak — Elemen jeda 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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

NamaJenisDeskripsi
textStringIsi 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.

// 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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

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

Menghapus konten elemen.

Pulang pergi

Paragraph — Elemen saat ini.


copy()

Menampilkan salinan mendalam yang terlepas dari elemen saat ini.

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

Pulang pergi

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

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

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

const 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 menemukan turunan dari jenis yang ditentukan.

Parameter

NamaJenisDeskripsi
elementTypeElementTypeJenis elemen yang akan ditelusuri.

Pulang pergi

RangeElement|null — 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 menemukan keturunan dari jenis yang ditentukan, dimulai dari RangeElement yang ditentukan.

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parameter

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

Pulang pergi

RangeElement|null — 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 pengambilan dan pengubah mode.

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

Parameter

NamaJenisDeskripsi
searchPatternStringpola yang akan ditelusuri

Pulang pergi

RangeElement|null — 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 menemukan pola teks yang ditentukan, dimulai dari hasil penelusuran tertentu.

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

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

Parameter

NamaJenisDeskripsi
searchPatternStringpola yang akan ditelusuri
fromRangeElementhasil penelusuran yang akan digunakan untuk memulai penelusuran

Pulang pergi

RangeElement|null — 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

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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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());

Pulang pergi

HorizontalAlignment|null — Penyelarasan.

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.

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

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

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

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

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

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

Parameter

NamaJenisDeskripsi
childIndexIntegerIndeks elemen turunan yang akan diambil.

Pulang pergi

Element — Elemen turunan pada indeks yang ditentukan.

Otorisasi

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

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

getChildIndex(child)

Mengambil indeks turunan untuk elemen turunan yang ditentukan.

Parameter

NamaJenisDeskripsi
childElementElemen turunan yang indeksnya akan diambil.

Pulang pergi

Integer — Indeks turunan.

Otorisasi

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

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

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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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());

Pulang pergi

ParagraphHeading|null — 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|null — 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|null — 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|null — 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 jarak antarbaris, dalam poin.

Pulang pergi

Number|null — jarak antarbaris, 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

getLinkUrl()

Mengambil URL link.

Pulang pergi

String|null — 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 pasangan berikutnya dari elemen.

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

Pulang pergi

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

const 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|null — 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

NamaJenisDeskripsi
idStringID 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 saudara sebelumnya dari elemen.

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

Pulang pergi

Element|null — Elemen saudara 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 jarak setelah elemen, dalam poin.

Pulang pergi

Number|null — spasi setelah elemen, 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

getSpacingBefore()

Mengambil spasi sebelum elemen, dalam poin.

Pulang pergi

Number|null — spasi sebelum elemen, 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

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|null — 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 pasti elemen tertentu.

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

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

const 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

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen akan disisipkan

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

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen akan disisipkan
imageBlobSourcedata 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 diberikan pada indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen akan disisipkan
imageInlineImagedata 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 ada dalam TableCells. Jika elemen saat ini ada dalam sel tabel, pengecualian akan ditampilkan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen akan disisipkan

Pulang pergi

PageBreak — elemen jeda 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 diberikan pada indeks yang ditentukan.

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

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen akan disisipkan
pageBreakPageBreakbatas halaman yang akan disisipkan

Pulang pergi

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

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen akan disisipkan
textStringisi 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 konten teks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen akan disisipkan
textTextelemen 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|null — 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 elemen saudara sebelumnya dengan jenis yang sama.

Hanya elemen dengan ElementType yang sama yang dapat digabungkan. Elemen turunan apa pun yang ada dalam elemen saat ini dipindahkan ke elemen saudara sebelumnya.

Elemen saat ini akan dihapus dari dokumen.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Pulang pergi

Paragraph|null — Elemen gabungan.

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

Pulang pergi

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.

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

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Pulang pergi

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

NamaJenisDeskripsi
idStringID gambar

Pulang pergi

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. Oleh karena itu, Anda harus meng-escape semua 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 terpisah dengan setiap blok teks yang ada dalam elemen saat ini.

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

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

Parameter

NamaJenisDeskripsi
searchPatternStringpola regex yang akan dicari
replacementStringteks yang akan 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

NamaJenisDeskripsi
alignmentHorizontalAlignmentperataan horizontal

Pulang pergi

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.

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

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

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

Parameter

NamaJenisDeskripsi
attributesObjectAtribut elemen.

Pulang pergi

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

NamaJenisDeskripsi
headingParagraphHeadingjudul

Pulang pergi

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

Parameter

NamaJenisDeskripsi
indentEndNumberindentasi akhir, dalam poin

Pulang pergi

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

NamaJenisDeskripsi
indentFirstLineNumberindentasi baris pertama, dalam poin

Pulang pergi

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

NamaJenisDeskripsi
indentStartNumberindentasi awal, dalam poin

Pulang pergi

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

NamaJenisDeskripsi
leftToRightBooleansetelan kiri ke kanan

Pulang pergi

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 jarak antar-baris, sebagai kuantitas yang menunjukkan jumlah baris yang akan digunakan untuk jarak.

Parameter

NamaJenisDeskripsi
multiplierNumberjumlah baris

Pulang pergi

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

NamaJenisDeskripsi
urlStringURL link

Pulang pergi

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

Parameter

NamaJenisDeskripsi
spacingAfterNumberspasi setelah elemen, dalam poin

Pulang pergi

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 jarak sebelum elemen, dalam poin.

Parameter

NamaJenisDeskripsi
spacingBeforeNumberspasi sebelum elemen, dalam poin

Pulang pergi

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

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

Parameter

NamaJenisDeskripsi
textAlignmentTextAlignmentjenis perataan teks yang akan diterapkan

Pulang pergi

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