Class RangeElement

RangeElement

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

Methoden

MethodeRückgabetypKurzbeschreibung
getElement()ElementRuft die Element ab, die diesem RangeElement entspricht.
getEndOffsetInclusive()IntegerRuft die Position des Endes eines Teilbereichs innerhalb des Bereichselements ab.
getStartOffset()IntegerRuft die Position des Beginns eines Teilbereichs innerhalb des Bereichselements ab.
isPartial()BooleanGibt an, ob dieses Bereichselement das gesamte Element oder eine teilweise Auswahl der Zeichen des Elements abdeckt.

Detaillierte Dokumentation

getElement()

Ruft die Element ab, die diesem RangeElement entspricht. 

const rangeElement = DocumentApp.getActiveDocument().getSelection().getRangeElements()[0];

// 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 diesem RangeElement entspricht.

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

getEndOffsetInclusive()

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

Rückflug

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

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

getStartOffset()

Ruft die Position des Beginns 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 Beginn des Bereichs (d. h. der Index des ersten Zeichens im Bereich). Andernfalls gibt diese Methode -1 zurück.

Rückflug

Integer – für Text-Elemente die Anzahl der Zeichen vor dem Beginn des Bereichs; für andere Elemente -1

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

isPartial()

Gibt an, ob dieses Bereichselement das gesamte Element oder eine teilweise Auswahl der Zeichen des Elements abdeckt. Der Anfang und das Ende des Bereichs eines Elements mit Teilbereich können mit getStartOffset() bzw. getEndOffsetInclusive() bestimmt werden.

Rückflug

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

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