Ein Builder, mit dem Range
-Objekte aus Dokumentelementen erstellt werden.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addElement(element) | RangeBuilder | Fügt diesem RangeBuilder ein vollständiges Element hinzu. |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | Fügt diesem RangeBuilder ein partielles Text -Element hinzu. |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | Fügt diesem RangeBuilder zwei vollständige Elemente sowie alle Elemente dazwischen hinzu. |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | Fügt zwei partielle Text -Elemente sowie alle Elemente dazwischen dem RangeBuilder -Element hinzu. |
addRange(range) | RangeBuilder | Fügt diesem RangeBuilder den Inhalt eines anderen Range hinzu. |
build() | Range | Erstellt ein Range aus den auf den Builder angewendeten Einstellungen. |
getRangeElements() | RangeElement[] | Ruft alle Elemente in dieser Range ab, einschließlich aller Text -Teilelemente (z. B. bei einer Auswahl, die nur einen Teil eines Text -Elements enthält). |
Detaillierte Dokumentation
addElement(element)
Fügt diesem RangeBuilder
ein vollständiges Element
hinzu.
Parameter
Name | Typ | Beschreibung |
---|---|---|
element | Element | das hinzuzufügende Element |
Return
RangeBuilder
– dieser Builder zum Verketten
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 diesem RangeBuilder
ein partielles Text
-Element hinzu.
Parameter
Name | Typ | Beschreibung |
---|---|---|
textElement | Text | das teilweise hinzuzufügende Textelement |
startOffset | Integer | Die Anzahl der Zeichen vor dem ersten einzuschließenden Zeichen (d. h. der Index des ersten Zeichens im Bereich) |
endOffsetInclusive | Integer | die Anzahl der Zeichen vor dem letzten Zeichen, die eingeschlossen werden sollen (d. h. der Index des letzten Zeichens im Bereich) |
Return
RangeBuilder
– dieser Builder zum Verketten
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 diesem RangeBuilder
zwei vollständige Elemente sowie alle Elemente dazwischen hinzu.
Parameter
Name | Typ | Beschreibung |
---|---|---|
startElement | Element | das erste Element, das hinzugefügt werden soll, |
endElementInclusive | Element | das letzte hinzuzufügende Element |
Return
RangeBuilder
– dieser Builder zum Verketten
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 sowie alle Elemente dazwischen dem RangeBuilder
-Element hinzu.
Parameter
Name | Typ | Beschreibung |
---|---|---|
startTextElement | Text | das erste teilweise hinzugefügte Textelement |
startOffset | Integer | Die Anzahl der Zeichen vor dem ersten Zeichen von startTextElement , die eingeschlossen werden sollen (d. h. der Index des ersten Zeichens im Bereich) |
endTextElementInclusive | Text | das letzte teilweise hinzugefügte Textelement |
endOffsetInclusive | Integer | Die Anzahl der Zeichen vor dem letzten Zeichen von endTextElementInclusive , die eingeschlossen werden sollen (d. h. der Index des letzten Zeichens im Bereich) |
Return
RangeBuilder
– dieser Builder zum Verketten
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 diesem RangeBuilder
den Inhalt eines anderen Range
hinzu.
Parameter
Name | Typ | Beschreibung |
---|---|---|
range | Range | Bereich, dessen Elemente hinzugefügt werden sollen |
Return
RangeBuilder
– dieser Builder zum Verketten
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 auf den Builder angewendeten Einstellungen.
Return
Range
– der neu erstellte Bereich
getRangeElements()
Ruft alle Elemente in dieser Range
ab, einschließlich aller Text
-Teilelemente (z. B. bei einer Auswahl, die nur einen Teil eines Text
-Elements enthält). Informationen dazu, ob ein Text
-Element nur teilweise im Bereich enthalten ist, finden Sie unter RangeElement.isPartial()
.
Return
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