Class RangeBuilder

RangeBuilder

Ein Builder, der zum Erstellen von Range-Objekten aus Dokumentelementen verwendet wird. 

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

Methoden

MethodeRückgabetypKurzbeschreibung
addElement(element)RangeBuilderFügt diesem RangeBuilder einen vollständigen Element hinzu.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderFügt dieser RangeBuilder ein unvollständiges Text-Element hinzu.
addElementsBetween(startElement, endElementInclusive)RangeBuilderFügt zwei ganze Elemente und alle Elemente dazwischen zu diesem RangeBuilder hinzu.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderFügt zwei partielle Text-Elemente und alle Elemente dazwischen zum RangeBuilder hinzu.
addRange(range)RangeBuilderFügt den Inhalt eines anderen Range zu diesem RangeBuilder hinzu.
build()RangeErstellt ein Range aus den Einstellungen, die auf den Builder angewendet wurden.
getRangeElements()RangeElement[]Ruft alle Elemente in dieser Range ab, einschließlich jeglicher Text-Teilelemente (z. B. im Fall von einer Auswahl, die nur einen Teil eines Text-Elements enthält).

Detaillierte Dokumentation

addElement(element)

Fügt diesem RangeBuilder einen vollständigen Element hinzu.

Parameter

NameTypBeschreibung
elementElementdas hinzuzufügende Element

Rückflug

RangeBuilder – dieser Builder für Verkettungen

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addElement(textElement, startOffset, endOffsetInclusive)

Fügt dieser RangeBuilder ein unvollständiges Text-Element hinzu.

Parameter

NameTypBeschreibung
textElementTextdas Textelement, das teilweise hinzugefügt werden soll
startOffsetIntegerAnzahl der Zeichen vor dem ersten Zeichen, das eingefügt werden soll (d. h. Index des ersten Zeichens im Bereich)
endOffsetInclusiveIntegerAnzahl der Zeichen vor dem letzten Zeichen, das eingefügt werden soll (d. h. Index des letzten Zeichens im Bereich)

Rückflug

RangeBuilder – dieser Builder für Verkettungen

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addElementsBetween(startElement, endElementInclusive)

Fügt zwei ganze Elemente und alle Elemente dazwischen zu diesem RangeBuilder hinzu.

Parameter

NameTypBeschreibung
startElementElementdas erste Element, das hinzugefügt werden soll,
endElementInclusiveElementdas letzte hinzuzufügende Element

Rückflug

RangeBuilder – dieser Builder für Verkettungen

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

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

Parameter

NameTypBeschreibung
startTextElementTextDas erste Textelement, das teilweise hinzugefügt werden soll
startOffsetIntegerAnzahl der Zeichen vor dem ersten Zeichen von startTextElement, die eingeschlossen werden sollen (d. h. 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 für Verkettungen

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addRange(range)

Fügt den Inhalt eines anderen Range zu diesem RangeBuilder hinzu.

Parameter

NameTypBeschreibung
rangeRangeBereich, dessen Elemente hinzugefügt werden sollen

Rückflug

RangeBuilder – dieser Builder für Verkettungen

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

build()

Erstellt ein Range aus den Einstellungen, die auf den Builder angewendet wurden.

Rückflug

Range: der neu erstellte Bereich

getRangeElements()

Ruft alle Elemente in dieser Range ab, einschließlich jeglicher Text-Teilelemente (z. B. im Fall von einer Auswahl, die nur einen Teil eines Text-Elements enthält). Um zu ermitteln, ob ein Das Text-Element ist nur teilweise im Bereich enthalten, siehe RangeElement.isPartial().

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Verworfene Methoden