Class RangeElement

Элемент диапазона

Обертка вокруг Element с возможным смещением начала и конца. Эти смещения позволяют представлять диапазон символов внутри элемента Text в результатах поиска, выделенных документах и ​​именованных диапазонах.

Методы

Метод Тип возврата Краткое описание
get Element() Element Получает Element , соответствующий этому Range Element .
get End Offset Inclusive() Integer Получает позицию конца частичного диапазона внутри элемента диапазона.
get Start Offset() Integer Получает позицию начала частичного диапазона внутри элемента диапазона.
is Partial() Boolean Определяет, охватывает ли этот элемент диапазона весь элемент или частичный набор символов элемента.

Подробная документация

get Element()

Получает Element , соответствующий этому Range Element .

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

Возвращаться

Element — элемент, соответствующий этому Range Element

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

get End Offset Inclusive()

Получает позицию конца частичного диапазона внутри элемента диапазона. Если элемент является элементом Text и is Partial() возвращает true , смещение — это количество символов перед последним символом в диапазоне (то есть индекс последнего символа в диапазоне); в любом другом случае этот метод возвращает -1 .

Возвращаться

Integer — для Text элементов количество символов перед последним символом диапазона; для остальных элементов -1

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

get Start Offset()

Получает позицию начала частичного диапазона внутри элемента диапазона. Если элемент является элементом Text и is Partial() возвращает true , смещение — это количество символов до начала диапазона (то есть индекс первого символа в диапазоне); в любом другом случае этот метод возвращает -1 .

Возвращаться

Integer — для Text элементов количество символов до начала диапазона; для остальных элементов -1

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

is Partial()

Определяет, охватывает ли этот элемент диапазона весь элемент или частичный набор символов элемента. Начало и конец диапазона элемента частичного диапазона можно определить с помощью методов get Start Offset() и get End Offset Inclusive() соответственно.

Возвращаться

Boolean — true , если элемент включен частично; false если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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