Stay organized with collections Save and categorize content based on your preferences.
RangeBuilderA 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.
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()); 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). Deprecated methods Method Return type Brief description getSelectedElements() RangeElement[] 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 RangeBuilder.
element Element the element to be added Return
RangeBuilder — this builder, for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documentsaddElement(textElement, startOffset, endOffsetInclusive)
Adds a partial Text element to this RangeBuilder.
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
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documentsaddElementsBetween(startElement, endElementInclusive)
Adds two entire elements, and all elements between them, to this RangeBuilder.
startElement Element the first element to be added endElementInclusive Element the last element to be added Return
RangeBuilder — this builder, for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documentsaddElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)
Adds two partial Text elements, and all elements between them, to the RangeBuilder.
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
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documentsaddRange(range)
Adds the contents of another Range to this RangeBuilder.
range Range the range whose elements should be added Return
RangeBuilder — this builder, for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documentsbuild()
Constructs a Range from the settings applied to the builder.
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().
RangeElement[] — an array of elements, in the order they appear in the document
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documentsgetSelectedElements()
Deprecated. Renamed to getRangeElements().
Gets all elements that the user has selected in the open instance of the document, including any partially selected Text elements.
RangeElement[] — an array of selected or partially selected elements, in the order they appear in the document
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documentsExcept as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["`RangeBuilder` helps construct `Range` objects, defining sections within a Google Doc, using various methods to specify elements or portions of text."],["You can add entire or partial elements to the `Range` using `addElement`, `addElementsBetween`, or by incorporating existing `Range` objects with `addRange`."],["The `build` method finalizes the `Range` construction, enabling you to apply formatting or other operations to the designated content."],["`getRangeElements` provides access to all elements within the `Range`, including partially selected text elements for granular control and manipulation."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4