Google Apps Script

Class RangeElement

A wrapper around an Element with a possible start and end offset. These offsets allow a range of characters within a Text element to be represented in search results, document selections, and named ranges.

Methods

MethodReturn typeBrief description
getElement()ElementGets the Element that corresponds to this RangeElement.
getEndOffsetInclusive()IntegerGets the position of the end of a partial range within the range element.
getStartOffset()IntegerGets the position of the start of a partial range within the range element.
isPartial()BooleanDetermines whether this range element covers the entire element or a partial selection of the element's characters.

Detailed documentation

getElement()

Gets the Element that corresponds to this RangeElement.

 
// 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 — the element that corresponds to this RangeElement


getEndOffsetInclusive()

Gets the position of the end of a partial range within the range element. If the element is a Text element and isPartial() 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 elements, the number of character before the last character in the range; for other elements, -1


getStartOffset()

Gets the position of the start of a partial range within the range element. If the element is a Text element and isPartial() 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 elements, the number of characters before the start of the range; for other elements, -1


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() and getEndOffsetInclusive(), respectively.

Return

Booleantrue if the element is partially included; false if not

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.