Class RangeBuilder

RangeBuilder

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

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

Методы

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

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

addElement(element)

Добавляет весь Element в этот RangeBuilder .

Параметры

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

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

RangeBuilder — этот конструктор, для цепочек

Авторизация

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

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

addElement(textElement, startOffset, endOffsetInclusive)

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

Параметры

Имя Тип Описание
textElement Text текстовый элемент, который будет частично добавлен
startOffset Integer количество символов перед первым включаемым символом (то есть индекс первого символа в диапазоне)
endOffsetInclusive Integer количество символов перед последним включаемым символом (то есть индекс последнего символа в диапазоне)

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

RangeBuilder — этот конструктор, для цепочек

Авторизация

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

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

addElementsBetween(startElement, endElementInclusive)

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

Параметры

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

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

RangeBuilder — этот конструктор, для цепочек

Авторизация

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

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

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

Параметры

Имя Тип Описание
startTextElement Text первый текстовый элемент, который будет частично добавлен
startOffset Integer количество символов до первого символа элемента startTextElement , которое необходимо включить (то есть индекс первого символа в диапазоне)
endTextElementInclusive Text последний текстовый элемент, который будет частично добавлен
endOffsetInclusive Integer количество символов перед последним символом endTextElementInclusive , которое будет включено (то есть индекс последнего символа в диапазоне)

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

RangeBuilder — этот конструктор, для цепочек

Авторизация

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

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

addRange(range)

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

Параметры

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

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

RangeBuilder — этот конструктор, для цепочек

Авторизация

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

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

build()

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

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

Range — вновь построенный полигон

getRangeElements()

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

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

RangeElement[] — массив элементов в порядке их появления в документе.

Авторизация

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

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

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