Class RangeBuilder

BereichBuilder

Ein Builder, mit dem Range-Objekte aus Dokumentelementen erstellt werden. 

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

Methoden

MethodeRückgabetypKurzbeschreibung
addElement(element)RangeBuilderFügt diesem RangeBuilder eine vollständige Element hinzu.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderFügt diesem RangeBuilder ein teilweises Text-Element hinzu.
addElementsBetween(startElement, endElementInclusive)RangeBuilderFügen Sie diesem RangeBuilder zwei vollständige Elemente und alle Elemente dazwischen hinzu.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderDem RangeBuilder werden zwei teilweise Text-Elemente und alle Elemente dazwischen hinzugefügt.
addRange(range)RangeBuilderFügt diesem RangeBuilder den Inhalt einer anderen Range hinzu.
build()RangeErstellt ein Range aus den auf den Builder angewendeten Einstellungen.
getRangeElements()RangeElement[]Hiermit werden alle Elemente in dieser Range abgerufen, einschließlich teilweiser Text-Elemente (z. B. bei einer Auswahl, die nur einen Teil eines Text-Elements enthält).

Detaillierte Dokumentation

addElement(element)

Fügt diesem RangeBuilder eine vollständige Element hinzu.

Parameter

NameTypBeschreibung
elementElementdas hinzuzufügende Element

Rückflug

RangeBuilder – dieser Builder, zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addElement(textElement, startOffset, endOffsetInclusive)

Fügt diesem RangeBuilder ein teilweises Text-Element hinzu.

Parameter

NameTypBeschreibung
textElementTextdas Textelement, das teilweise hinzugefügt werden soll
startOffsetIntegerdie Anzahl der Zeichen vor dem ersten Zeichen, das eingeschlossen werden soll (d. h. der Index des ersten Zeichens im Bereich)
endOffsetInclusiveIntegerdie Anzahl der Zeichen vor dem letzten Zeichen, das eingeschlossen werden soll (d. h. der Index des letzten Zeichens im Bereich)

Rückflug

RangeBuilder – dieser Builder, zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addElementsBetween(startElement, endElementInclusive)

Fügen Sie diesem RangeBuilder zwei vollständige Elemente und alle Elemente dazwischen hinzu.

Parameter

NameTypBeschreibung
startElementElementdas erste hinzuzufügende Element
endElementInclusiveElementdas letzte hinzugefügte Element

Rückflug

RangeBuilder – dieser Builder, zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

Dem RangeBuilder werden zwei teilweise Text-Elemente und alle Elemente dazwischen hinzugefügt.

Parameter

NameTypBeschreibung
startTextElementTextdas erste Textelement, das teilweise hinzugefügt werden soll
startOffsetIntegerdie Anzahl der Zeichen vor dem ersten Zeichen von startTextElement, das eingeschlossen werden soll (d. h. der Index des ersten Zeichens im Bereich)
endTextElementInclusiveTextdas letzte Textelement, das teilweise hinzugefügt werden soll
endOffsetInclusiveIntegerdie Anzahl der Zeichen vor dem letzten Zeichen von endTextElementInclusive, das eingeschlossen werden soll (d. h. der Index des letzten Zeichens im Bereich)

Rückflug

RangeBuilder – dieser Builder, zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addRange(range)

Fügt diesem RangeBuilder den Inhalt einer anderen Range hinzu.

Parameter

NameTypBeschreibung
rangeRangeden Bereich, dessen Elemente hinzugefügt werden sollen

Rückflug

RangeBuilder – dieser Builder, zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

build()

Erstellt ein Range aus den auf den Builder angewendeten Einstellungen.

Rückflug

Range – der neu erstellte Bereich

getRangeElements()

Hiermit werden alle Elemente in dieser Range abgerufen, einschließlich teilweiser Text-Elemente (z. B. bei einer Auswahl, die nur einen Teil eines Text-Elements enthält). Ob ein Text-Element nur teilweise im Bereich enthalten ist, sehen Sie unter RangeElement.isPartial().

Rückflug

RangeElement[]: ein Array von Elementen in der Reihenfolge, in der sie im Dokument erscheinen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Eingestellte Methoden