Class RangeElement

ElementElement

Kod otaczający element Element, z możliwym przesunięciem. Te przesunięcia pozwalają na wyświetlanie zakresu znaków w elemencie Text w wynikach wyszukiwania, wyborze dokumentów i nazwanych zakresach.

Metody

MetodaZwracany typKrótki opis
getElement()ElementPobiera Element, który odpowiada temu RangeElement.
getEndOffsetInclusive()IntegerPobiera pozycję końca zakresu częściowego w zakresie.
getStartOffset()IntegerPobiera pozycję początku części zakresu w elemencie zakresu.
isPartial()BooleanOkreśla, czy ten element zakresu obejmuje cały element czy częściowy wybór znaków elementu.

Szczegółowa dokumentacja

getElement()

Pobiera Element, który odpowiada temu 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.');
}

Zwróć

Element – element odpowiadający temu RangeElement

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getEndOffsetInclusive()

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

Zwróć

Integer – w przypadku elementów Text jest to liczba znaków przed ostatnim znakiem w zakresie, a w przypadku innych elementów -1

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getStartOffset()

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

Zwróć

Integer – w przypadku elementów Text jest to liczba znaków poprzedzająca początek zakresu, a w przypadku innych elementów -1

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 częściowy wybór znaków elementu. Początek i koniec zakresu częściowego zakresu można określić za pomocą odpowiednio parametrów getStartOffset() i getEndOffsetInclusive().

Zwróć

Booleantrue, jeśli element został częściowo uwzględniony; jeśli nie, false

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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