Class RangeElement

RangeElement

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

Методы

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

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

getElement()

Получает Element , соответствующий данному RangeElement .

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 — элемент, соответствующий данному RangeElement

Авторизация

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

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

getEndOffsetInclusive()

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

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

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

Авторизация

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

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

getStartOffset()

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

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

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

Авторизация

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

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

isPartial()

Определяет, охватывает ли данный элемент диапазона весь элемент или лишь его часть. Начало и конец диапазона для частичного элемента диапазона можно определить с помощью getStartOffset() и getEndOffsetInclusive() соответственно.

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

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

Авторизация

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

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