Class RangeElement

RangeElement

Ein Wrapper um ein Element mit einem möglichen Start- und Endversatz. Mit diesen Offsets kann ein Zeichenbereich innerhalb eines Text-Elements in Suchergebnissen, Dokumentauswahlen und benannten Bereichen dargestellt werden.

Methoden

MethodeRückgabetypKurzbeschreibung
getElement()ElementRuft die Element ab, die dieser RangeElement entspricht.
getEndOffsetInclusive()IntegerRuft die Position des Endes eines Teilbereichs innerhalb des Bereichselements ab.
getStartOffset()IntegerRuft die Position des Anfangs eines Teilbereichs innerhalb des Bereichselements ab.
isPartial()BooleanBestimmt, ob dieses Bereichselement das gesamte Element oder nur einen Teil der Zeichen des Elements abdeckt.

Detaillierte Dokumentation

getElement()

Ruft die Element ab, die dieser RangeElement entspricht.

// Log debug information about a range element.
Logger.log('Element type: ' + rangeElement.getElement().getType());
if (rangeElement.isPartial()) {
  Logger.log('The character range begins at ' + rangeElement.getStartOffset());
  Logger.log('The character range ends at ' + rangeElement.getEndOffsetInclusive());
} else {
  Logger.log('The entire range element is included.');
}

Return

Element: das Element, das dieser RangeElement entspricht

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

getEndOffsetInclusive()

Ruft die Position des Endes eines Teilbereichs innerhalb des Bereichselements ab. Wenn das Element ein Text-Element ist und isPartial() true zurückgibt, ist der Offset die Anzahl der Zeichen vor dem letzten Zeichen im Bereich (d. h. dem Index des letzten Zeichens im Bereich). In allen anderen Fällen gibt diese Methode -1 zurück.

Return

Integer: Bei Text-Elementen die Anzahl der Zeichen vor dem letzten Zeichen im Bereich; bei anderen Elementen -1.

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

getStartOffset()

Ruft die Position des Anfangs eines Teilbereichs innerhalb des Bereichselements ab. Wenn das Element ein Text-Element ist und isPartial() true zurückgibt, ist das Offset die Anzahl der Zeichen vor dem Beginn des Bereichs (d. h. der Index des ersten Zeichens im Bereich). In allen anderen Fällen gibt diese Methode -1 zurück.

Return

Integer: Bei Text-Elementen die Anzahl der Zeichen vor dem Beginn des Bereichs; bei anderen Elementen -1.

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

isPartial()

Bestimmt, ob dieses Bereichselement das gesamte Element oder nur einen Teil der Zeichen des Elements abdeckt. Der Anfang und das Ende des Bereichs eines Teilbereichs können mit getStartOffset() bzw. getEndOffsetInclusive() ermittelt werden.

Return

Boolean: true, wenn das Element teilweise enthalten ist; false, wenn nicht

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