Class RangeBuilder

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 Добавляет в Range Builder два элемента "Частичный Text и все элементы между ними.
add Range(range) Range Builder Добавляет содержимое другого Range в этот Range Builder .
build() Range Создает Range на основе настроек, примененных к конструктору.
get Range Elements() Range Element[] Получает все элементы в этом 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 .

Параметры

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

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

RangeBuilder — этот построитель для создания цепочек вызовов.

Авторизация

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

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

addElementsBetween(startElement, endElementInclusive)

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

Параметры

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

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

RangeBuilder — этот построитель для создания цепочек вызовов.

Авторизация

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

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

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

Параметры

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

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

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

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