Class RangeElement

RangeElement

Ein Wrapper um ein Element mit einem möglichen Start- und Endversatz. Diese Offsets ermöglichen eine Zeichenbereich innerhalb von Text -Element, das in Suchergebnissen, der Dokumentauswahl und benannten Bereichen dargestellt werden soll.

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 abdeckt oder eine Teilauswahl des Elements Zeichen des Elements enthält.

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.');
}

Rückflug

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 und isPartial() gibt true zurück. Der Offset ist die Anzahl der Zeichen vor dem letzten Zeichen im Bereich (d. h. Index des letzten Zeichens im Bereich); in anderen gibt diese Methode -1 zurück.

Rückflug

Integer – für Text-Elemente Anzahl der Zeichen vor dem letzten Zeichen im Bereich; für andere Elemente, -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 und isPartial() gibt true zurück. Der Offset ist die Anzahl der Zeichen vor dem Anfang von den Bereich, d. h. den Index des ersten Zeichens im Bereich, In jedem anderen Fall gibt -1 zurück.

Rückflug

Integer – für Text-Elemente Anzahl der Zeichen vor dem Beginn des Bereichs; für andere Elemente, -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 abdeckt oder eine Teilauswahl des Elements Zeichen des Elements enthält. Der Anfang und das Ende des Bereichs eines Teilbereichs des Bereichs können ermittelt mit getStartOffset() bzw. getEndOffsetInclusive().

Rückflug

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