Class RangeBuilder
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
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 construct Range 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 entire Element to this Range. |
add | Range | Adds a partial Text element to this Range. |
add | Range | Adds two entire elements, and all elements between them, to this Range. |
add | Range | Adds two partial Text elements, and all elements between them, to the Range. |
add | Range | Adds the contents of another Range to this Range. |
build() | Range | Constructs a Range from the settings applied to the builder. |
get | Range | 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). |
Deprecated methods
| Method | Return type | Brief description |
|---|---|---|
| Range | Gets all elements that the user has selected in the open instance of the document, including
any partially selected Text
elements. |
Detailed documentation
addElement(element)
Adds an entire Element to this Range.
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 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 Range.
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 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 Range.
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 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 Range.
Parameters
| Name | Type | Description |
|---|---|---|
start | Text | the first text element to be partially added |
start | Integer | the number of characters before the first character of start 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 of end 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 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 Range.
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 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 Range.
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 following scopes:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
Deprecated methods
(削除) getSelectedElements() (削除ここまで)
getSelectedElements() (削除ここまで)
Deprecated. Renamed to get.
Gets all elements that the user has selected in the open instance of the document, including
any partially selected Text
elements.
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 following scopes:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents