A builder used to construct Range
objects from document elements.
// 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());
Methods
Method | Return type | Brief description |
---|---|---|
addElement(element) | RangeBuilder | Adds an entire Element to this RangeBuilder . |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | Adds a partial Text element to this RangeBuilder . |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | Adds two entire elements, and all elements between them, to this RangeBuilder . |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | Adds two partial Text elements, and all elements between them, to the RangeBuilder . |
addRange(range) | RangeBuilder | Adds the contents of another Range to this RangeBuilder . |
build() | Range | Constructs a Range from the settings applied to the builder. |
getRangeElements() | RangeElement[] | Gets all elements in this Range , including any partial Text elements (for example, in the case
of a selection that includes only part of a Text element). |
Detailed documentation
addElement(element)
Adds an entire Element
to this RangeBuilder
.
Parameters
Name | Type | Description |
---|---|---|
element | Element | the element to be added |
Return
RangeBuilder
— this builder, for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElement(textElement, startOffset, endOffsetInclusive)
Adds a partial Text
element to this RangeBuilder
.
Parameters
Name | Type | Description |
---|---|---|
textElement | Text | the text element to be partially added |
startOffset | Integer | the number of characters before the first character to be included (that is, the index of the first character in the range) |
endOffsetInclusive | Integer | the number of characters before the last character to be included (that is, the index of the last character in the range) |
Return
RangeBuilder
— this builder, for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElementsBetween(startElement, endElementInclusive)
Adds two entire elements, and all elements between them, to this RangeBuilder
.
Parameters
Name | Type | Description |
---|---|---|
startElement | Element | the first element to be added |
endElementInclusive | Element | the last element to be added |
Return
RangeBuilder
— this builder, for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)
Adds two partial Text
elements, and all elements between them, to the RangeBuilder
.
Parameters
Name | Type | Description |
---|---|---|
startTextElement | Text | the first text element to be partially added |
startOffset | Integer | the number of characters before the first character of startTextElement to be included (that is, the index of the first character in the range) |
endTextElementInclusive | Text | the last text element to be partially added |
endOffsetInclusive | Integer | the number of characters before the last character of endTextElementInclusive to be included (that is, the index of the last character in the
range) |
Return
RangeBuilder
— this builder, for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addRange(range)
Adds the contents of another Range
to this RangeBuilder
.
Parameters
Name | Type | Description |
---|---|---|
range | Range | the range whose elements should be added |
Return
RangeBuilder
— this builder, for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
build()
Constructs a Range
from the settings applied to the builder.
Return
Range
— the newly constructed range
getRangeElements()
Gets all elements in this Range
, including any partial Text
elements (for example, in the case
of a selection that includes only part of a Text
element). To determine whether a
Text
element is only partially included in the range, see RangeElement.isPartial()
.
Return
RangeElement[]
— an array of elements, in the order they appear in the document
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents