Построитель, используемый для создания объектов Range
из элементов документа.
// Change the user's selection to a range that includes every table in the active tab. var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var rangeBuilder = documentTab.newRange(); var tables = documentTab.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 | Добавляет в RangeBuilder два частичных элемента Text и все элементы между ними. |
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)
Добавляет в RangeBuilder
два частичных элемента Text
и все элементы между ними.
Параметры
Имя | Тип | Описание |
---|---|---|
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
Устаревшие методы
Построитель, используемый для создания объектов Range
из элементов документа.
// Change the user's selection to a range that includes every table in the active tab. var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var rangeBuilder = documentTab.newRange(); var tables = documentTab.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 | Добавляет в RangeBuilder два частичных элемента Text и все элементы между ними. |
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)
Добавляет в RangeBuilder
два частичных элемента Text
и все элементы между ними.
Параметры
Имя | Тип | Описание |
---|---|---|
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