Class RangeElement | Apps Script | Google for Developers (original) (raw)
Class RangeElement
Stay organized with collections Save and categorize content based on your preferences.
RangeElement
A wrapper around an [Element](/apps-script/reference/document/element) with a possible start and end offset. These offsets allow a range of characters within a [Text](/apps-script/reference/document/text)element to be represented in search results, document selections, and named ranges.
Methods
| Method | Return type | Brief description |
|---|---|---|
| getElement() | Element | Gets the Element that corresponds to this RangeElement. |
| getEndOffsetInclusive() | Integer | Gets the position of the end of a partial range within the range element. |
| getStartOffset() | Integer | Gets the position of the start of a partial range within the range element. |
| isPartial() | Boolean | Determines whether this range element covers the entire element or a partial selection of the element's characters. |
Detailed documentation
getElement()
Gets the [Element](/apps-script/reference/document/element) that corresponds to this RangeElement.
const rangeElement = DocumentApp.getActiveDocument().getSelection().getRangeElements()[0];
// Log debug information about a range element.
Logger.log(Element type: ${rangeElement.getElement().getType()});
if (rangeElement.isPartial()) {
Logger.log(The character range begins at ${rangeElement.getStartOffset()});
Logger.log(
The character range ends at ${rangeElement.getEndOffsetInclusive()},
);
} else {
Logger.log('The entire range element is included.');
}
Return
[Element](/apps-script/reference/document/element) — the element that corresponds to this RangeElement
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/documents
getEndOffsetInclusive()
Gets the position of the end of a partial range within the range element. If the element is a[Text](/apps-script/reference/document/text) element and [isPartial()](#isPartial%28%29) returns true, the offset is the number of characters before the last character in the range (that is, the index of the last character in the range); in any other case, this method returns -1.
Return
Integer — for [Text](/apps-script/reference/document/text) elements, the number of character before the last character in the range; for other elements, -1
Authorization
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/documents
getStartOffset()
Gets the position of the start of a partial range within the range element. If the element is a[Text](/apps-script/reference/document/text) element and [isPartial()](#isPartial%28%29) returns true, the offset is the number of characters before the start of the range (that is, the index of the first character in the range); in any other case, this method returns -1.
Return
Integer — for [Text](/apps-script/reference/document/text) elements, the number of characters before the start of the range; for other elements, -1
Authorization
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/documents
isPartial()
Determines whether this range element covers the entire element or a partial selection of the element's characters. The beginning and end of a partial range element's range can be determined using [getStartOffset()](#getStartOffset%28%29) and [getEndOffsetInclusive()](#getEndOffsetInclusive%28%29), respectively.
Return
Boolean — true if the element is partially included; false if not
Authorization
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/documents
Except 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-02 UTC.