Class RangeElement

Bereich-Element

Ein Element-Wrapper mit einem möglichen Start- und Endoffset. Mit diesen Abweichungen können bestimmte 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()BooleanBestimmt, ob dieses Bereichselement das gesamte Element oder eine Teilauswahl 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, erfordern eine Autorisierung für einen oder mehrere 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. der Index des letzten Zeichens im Bereich). In allen anderen Fällen 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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). In allen anderen Fällen gibt diese Methode -1 zurück.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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 eine Teilauswahl der Zeichen des Elements abdeckt. Der Anfang und das Ende des Bereichs eines Elements mit teilweisem Bereich können mit getStartOffset() bzw. getEndOffsetInclusive() ermittelt werden.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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