Class RangeBuilder

RangeBuilder

Builder yang digunakan untuk membuat objek Range dari elemen dokumen. 

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addElement(element)RangeBuilderMenambahkan seluruh Element ke RangeBuilder ini.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderMenambahkan elemen Text sebagian ke RangeBuilder ini.
addElementsBetween(startElement, endElementInclusive)RangeBuilderMenambahkan dua elemen utuh, dan semua elemen di antaranya, ke RangeBuilder ini.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderMenambahkan dua elemen Text parsial, dan semua elemen di antaranya, ke RangeBuilder.
addRange(range)RangeBuilderMenambahkan konten Range lain ke RangeBuilder ini.
build()RangeMembuat Range dari setelan yang diterapkan ke builder.
getRangeElements()RangeElement[]Mendapatkan semua elemen dalam Range ini, termasuk elemen Text parsial (misalnya, dalam kasus pilihan yang hanya menyertakan sebagian elemen Text).

Dokumentasi mendetail

addElement(element)

Menambahkan seluruh Element ke RangeBuilder ini.

Parameter

NamaJenisDeskripsi
elementElementelemen yang akan ditambahkan

Pulang pergi

RangeBuilder — builder ini, untuk pembuatan rantai

Otorisasi

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

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

addElement(textElement, startOffset, endOffsetInclusive)

Menambahkan elemen Text sebagian ke RangeBuilder ini.

Parameter

NamaJenisDeskripsi
textElementTextelemen teks yang akan ditambahkan sebagian
startOffsetIntegerjumlah karakter sebelum karakter pertama yang akan disertakan (yaitu, indeks karakter pertama dalam rentang)
endOffsetInclusiveIntegerjumlah karakter sebelum karakter terakhir yang akan disertakan (yaitu, indeks karakter terakhir dalam rentang)

Pulang pergi

RangeBuilder — builder ini, untuk pembuatan rantai

Otorisasi

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

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

addElementsBetween(startElement, endElementInclusive)

Menambahkan dua elemen utuh, dan semua elemen di antaranya, ke RangeBuilder ini.

Parameter

NamaJenisDeskripsi
startElementElementelemen pertama yang akan ditambahkan
endElementInclusiveElementelemen terakhir yang akan ditambahkan

Pulang pergi

RangeBuilder — builder ini, untuk pembuatan rantai

Otorisasi

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

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

Menambahkan dua elemen Text parsial, dan semua elemen di antaranya, ke RangeBuilder.

Parameter

NamaJenisDeskripsi
startTextElementTextelemen teks pertama yang akan ditambahkan sebagian
startOffsetIntegerjumlah karakter sebelum karakter pertama startTextElement yang akan disertakan (yaitu, indeks karakter pertama dalam rentang)
endTextElementInclusiveTextelemen teks terakhir yang ditambahkan sebagian
endOffsetInclusiveIntegerjumlah karakter sebelum karakter terakhir endTextElementInclusive yang akan disertakan (yaitu, indeks karakter terakhir dalam rentang)

Pulang pergi

RangeBuilder — builder ini, untuk pembuatan rantai

Otorisasi

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

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

addRange(range)

Menambahkan konten Range lain ke RangeBuilder ini.

Parameter

NamaJenisDeskripsi
rangeRangerentang yang elemennya harus ditambahkan

Pulang pergi

RangeBuilder — builder ini, untuk pembuatan rantai

Otorisasi

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

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

build()

Membuat Range dari setelan yang diterapkan ke builder.

Pulang pergi

Range — rentang yang baru dibuat

getRangeElements()

Mendapatkan semua elemen dalam Range ini, termasuk elemen Text parsial (misalnya, dalam kasus pilihan yang hanya menyertakan sebagian elemen Text). Untuk menentukan apakah elemen Text hanya sebagian disertakan dalam rentang, lihat RangeElement.isPartial().

Pulang pergi

RangeElement[] — array elemen, sesuai urutan kemunculannya dalam 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

Metode yang tidak digunakan lagi