Class RangeBuilder

Строитель диапазона

Построитель, используемый для создания объектов Range из элементов документа.

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Методы

Метод Тип возврата Краткое описание
add Element(element) Range Builder Добавляет целый Element в этот Range Builder .
add Element(textElement, startOffset, endOffsetInclusive) Range Builder Добавляет частичный элемент Text в этот Range Builder .
add Elements Between(startElement, endElementInclusive) Range Builder Добавляет два целых элемента и все элементы между ними в этот Range Builder .
add Elements Between(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) Range Builder Добавляет два частичных элемента Text и все элементы между ними в Range Builder .
add Range(range) Range Builder Добавляет содержимое другого Range в этот Range Builder .
build() Range Создает Range на основе настроек, примененных к построителю.
get Range Elements() Range Element[] Получает все элементы в этом Range , включая любые частичные элементы Text (например, в случае выделения, которое включает только часть элемента Text ).

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

add Element(element)

Добавляет целый Element в этот Range Builder .

Параметры

Имя Тип Описание
element Element элемент, который нужно добавить

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

Range Builder — этот конструктор для создания цепочек

Авторизация

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

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

add Element(textElement, startOffset, endOffsetInclusive)

Добавляет частичный элемент Text в этот Range Builder .

Параметры

Имя Тип Описание
text Element Text текстовый элемент, который нужно добавить частично
start Offset Integer количество символов перед первым включаемым символом (то есть индекс первого символа в диапазоне)
end Offset Inclusive Integer количество символов перед последним включаемым символом (то есть индекс последнего символа в диапазоне)

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

Range Builder — этот конструктор для создания цепочек

Авторизация

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

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

add Elements Between(startElement, endElementInclusive)

Добавляет два целых элемента и все элементы между ними в этот Range Builder .

Параметры

Имя Тип Описание
start Element Element первый добавляемый элемент
end Element Inclusive Element последний элемент, который будет добавлен

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

Range Builder — этот конструктор для создания цепочек

Авторизация

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

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

add Elements Between(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

Добавляет два частичных элемента Text и все элементы между ними в Range Builder .

Параметры

Имя Тип Описание
start Text Element Text первый текстовый элемент, который будет добавлен частично
start Offset Integer количество символов перед первым символом start Text Element который необходимо включить (то есть индекс первого символа в диапазоне)
end Text Element Inclusive Text последний текстовый элемент, который будет добавлен частично
end Offset Inclusive Integer количество символов перед последним символом end Text Element Inclusive которое должно быть включено (то есть индекс последнего символа в диапазоне)

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

Range Builder — этот конструктор для создания цепочек

Авторизация

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

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

add Range(range)

Добавляет содержимое другого Range в этот Range Builder .

Параметры

Имя Тип Описание
range Range диапазон, элементы которого следует добавить

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

Range Builder — этот конструктор для создания цепочек

Авторизация

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

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

build()

Создает Range на основе настроек, примененных к построителю.

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

Range — недавно построенный диапазон

get Range Elements()

Получает все элементы в этом Range , включая любые частичные элементы Text (например, в случае выделения, которое включает только часть элемента Text ). Чтобы определить, включен ли элемент Text в диапазон только частично, см. Range Element.isPartial() .

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

Range Element[] — массив элементов в том порядке, в котором они появляются в документе.

Авторизация

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

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

Устаревшие методы