Class RangeElement

RangeElement

Otoka wokół elementu Element z możliwym przesunięciem początku i końca. Te przesunięcia umożliwiają odzwierciedlenie zakresu znaków w elemencie Text w wynikach wyszukiwania, wyborze dokumentów i zakresach nazwanych.

Metody

MetodaZwracany typKrótki opis
getElement()ElementPobiera element Element odpowiadający obiektowi RangeElement.
getEndOffsetInclusive()IntegerPobiera pozycję końca częściowego zakresu w elemencie zakresu.
getStartOffset()IntegerPobiera pozycję początku częściowego zakresu w elemencie zakresu.
isPartial()BooleanOkreśla, czy ten element zakresu obejmuje cały element, czy tylko część jego znaków.

Szczegółowa dokumentacja

getElement()

Pobiera element Element odpowiadający obiektowi RangeElement.

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

Powroty

Element – element odpowiadający obiektowi RangeElement,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getEndOffsetInclusive()

Pobiera pozycję końca częściowego zakresu w elemencie zakresu. Jeśli element jest elementem Text, a isPartial() zwraca wartość true, przesunięcie to liczba znaków przed ostatnim znakiem w zakresie (czyli indeksem ostatniego znaku w zakresie). W każdym innym przypadku ta metoda zwraca -1.

Powroty

Integer – w przypadku elementów Text liczba znaków przed ostatnim znakiem w zakresie; w przypadku innych elementów – -1

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getStartOffset()

Pobiera pozycję początku częściowego zakresu w elemencie zakresu. Jeśli element jest elementem Text, a isPartial() zwraca true, przesunięcie to liczba znaków poprzedzających początek zakresu (czyli indeks pierwszego znaku w zakresie). W każdym innym przypadku ta metoda zwraca -1.

Powroty

Integer – w przypadku elementów Text liczba znaków poprzedzających początek zakresu, a w przypadku pozostałych elementów – -1.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

isPartial()

Określa, czy ten element zakresu obejmuje cały element, czy tylko część jego znaków. Początek i koniec zakresu elementu częściowego zakresu można określić odpowiednio za pomocą getStartOffset() i getEndOffsetInclusive().

Powroty

Booleantrue, jeśli element jest uwzględniony częściowo; jeśli nie jest to element: false

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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