Class RangeBuilder
Page Summary
RangeBuilder is used to construct
Rangeobjects from document elements.It offers methods to add entire or partial elements, elements between two points, or contents of another range.
The
build()method constructs the finalRangeobject.The
getRangeElements()method retrieves all elements within the built range.getSelectedElements()is a deprecated method, replaced bygetRangeElements().
A builder used to constructRange objects from document elements.
// Change the user's selection to a range that includes every table in the// active tab.constdoc=DocumentApp.getActiveDocument();constdocumentTab=doc.getActiveTab().asDocumentTab();constrangeBuilder=documentTab.newRange();consttables=documentTab.getBody().getTables();for(leti=0;i <tables.length;i++){rangeBuilder.addElement(tables[i]);}doc.setSelection(rangeBuilder.build());
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Range | Adds an entireElement to thisRange. |
add | Range | Adds a partialText element to thisRange. |
add | Range | Adds two entire elements, and all elements between them, to thisRange. |
add | Range | Adds two partialText elements, and all elements between them, to theRange. |
add | Range | Adds the contents of anotherRange to thisRange. |
build() | Range | Constructs aRange from the settings applied to the builder. |
get | Range | Gets all elements in thisRange, including any partialText elements (for example, in the caseof a selection that includes only part of aText element). |
Deprecated methods
| Method | Return type | Brief description |
|---|---|---|
| Range | Gets all elements that the user has selected in the open instance of the document, includingany partially selectedTextelements. |
Detailed documentation
addElement(element)
Adds an entireElement to thisRange.
Parameters
| Name | Type | Description |
|---|---|---|
element | Element | the element to be added |
Return
Range — this builder, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
addElement(textElement, startOffset, endOffsetInclusive)
Adds a partialText element to thisRange.
Parameters
| Name | Type | Description |
|---|---|---|
text | Text | the text element to be partially added |
start | Integer | the number of characters before the first character to be included (that is, the index of the first character in the range) |
end | Integer | the number of characters before the last character to be included (that is, the index of the last character in the range) |
Return
Range — this builder, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
addElementsBetween(startElement, endElementInclusive)
Adds two entire elements, and all elements between them, to thisRange.
Parameters
| Name | Type | Description |
|---|---|---|
start | Element | the first element to be added |
end | Element | the last element to be added |
Return
Range — this builder, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)
Adds two partialText elements, and all elements between them, to theRange.
Parameters
| Name | Type | Description |
|---|---|---|
start | Text | the first text element to be partially added |
start | Integer | the number of characters before the first character ofstart to be included (that is, the index of the first character in the range) |
end | Text | the last text element to be partially added |
end | Integer | the number of characters before the last character ofend to be included (that is, the index of the last character in the range) |
Return
Range — this builder, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
addRange(range)
Adds the contents of anotherRange to thisRange.
Parameters
| Name | Type | Description |
|---|---|---|
range | Range | the range whose elements should be added |
Return
Range — this builder, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
build()
Constructs aRange from the settings applied to the builder.
Return
Range — the newly constructed range
getRangeElements()
Gets all elements in thisRange, including any partialText elements (for example, in the caseof a selection that includes only part of aText element). To determine whether aText element is only partially included in the range, seeRange.
Return
Range — 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 followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
Deprecated methods
getSelectedElements()
getSelectedElements() Deprecated. Renamed toget.
Gets all elements that the user has selected in the open instance of the document, includingany partially selectedTextelements.
Return
Range — an array of selected or partially selected elements, in the order they appear in the document
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.