Class RangeBuilder

RangeBuilder

Ein Builder zum Erstellen von Range-Objekten aus Dokumentelementen. 

// 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 ein ganzes Element hinzu.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderFügt diesem RangeBuilder ein partielles Text-Element hinzu.
addElementsBetween(startElement, endElementInclusive)RangeBuilderFügt dieser RangeBuilder zwei vollständige Elemente und alle Elemente dazwischen hinzu.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderFügt dem RangeBuilder zwei partielle Text-Elemente und alle Elemente dazwischen hinzu.
addRange(range)RangeBuilderFügt dieser RangeBuilder die Inhalte einer anderen Range hinzu.
build()RangeErstellt ein Range aus den auf den Builder angewendeten Einstellungen.
getRangeElements()RangeElement[]Ruft alle Elemente in diesem Range ab, einschließlich aller partiellen Text-Elemente (z. B. bei einer Auswahl, die nur einen Teil eines Text-Elements umfasst).

Detaillierte Dokumentation

addElement(element)

Fügt diesem RangeBuilder ein ganzes Element hinzu.

Parameter

NameTypBeschreibung
elementElementDas hinzuzufügende Element

Rückflug

RangeBuilder – dieser Builder zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

addElement(textElement, startOffset, endOffsetInclusive)

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

Parameter

NameTypBeschreibung
textElementTextDas Textelement, das teilweise hinzugefügt werden soll
startOffsetIntegerDie Anzahl der Zeichen vor dem ersten einzuschließenden Zeichen (d. h. der Index des ersten Zeichens im Bereich)
endOffsetInclusiveIntegerDie Anzahl der Zeichen vor dem letzten Zeichen, das berücksichtigt werden soll, d. h. der Index des letzten Zeichens im Bereich.

Rückflug

RangeBuilder – dieser Builder zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

addElementsBetween(startElement, endElementInclusive)

Fügt dieser RangeBuilder zwei vollständige Elemente und alle Elemente dazwischen hinzu.

Parameter

NameTypBeschreibung
startElementElementDas erste Element, das hinzugefügt werden soll
endElementInclusiveElementdas zuletzt hinzugefügte Element

Rückflug

RangeBuilder – dieser Builder zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

Fügt dem RangeBuilder zwei partielle Text-Elemente und alle Elemente dazwischen hinzu.

Parameter

NameTypBeschreibung
startTextElementTextDas erste Textelement, das teilweise hinzugefügt werden soll
startOffsetIntegerDie Anzahl der Zeichen vor dem ersten Zeichen von startTextElement, die eingeschlossen werden sollen (d. h. der Index des ersten Zeichens im Bereich)
endTextElementInclusiveTextdas letzte Textelement, das teilweise hinzugefügt wurde
endOffsetInclusiveIntegerDie Anzahl der Zeichen vor dem letzten Zeichen von endTextElementInclusive, die berücksichtigt werden sollen (d. h. der Index des letzten Zeichens im Bereich)

Rückflug

RangeBuilder – dieser Builder zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

addRange(range)

Fügt dieser RangeBuilder die Inhalte einer anderen Range hinzu.

Parameter

NameTypBeschreibung
rangeRangeDer Bereich, dessen Elemente addiert werden sollen

Rückflug

RangeBuilder – dieser Builder zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Ruft alle Elemente in diesem Range ab, einschließlich aller partiellen Text-Elemente (z. B. bei einer Auswahl, die nur einen Teil eines Text-Elements umfasst). Informationen dazu, ob ein Text-Element nur teilweise im Bereich enthalten ist, finden Sie unter RangeElement.isPartial().

Rückflug

RangeElement[] – ein Array von Elementen in der Reihenfolge, in der sie im Dokument angezeigt werden

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Eingestellte Methoden