開始オフセットと終了オフセットがある可能性のある Element を囲むラッパー。これらのオフセットにより、Text 要素内の文字の範囲を検索結果、ドキュメントの選択、名前付き範囲で表すことができます。
Methods
| 方法 | 戻り値の型 | 概要 |
|---|---|---|
getElement() | Element | この RangeElement に対応する Element を取得します。 |
getEndOffsetInclusive() | Integer | 範囲要素内の部分範囲の終点の位置を取得します。 |
getStartOffset() | Integer | 範囲要素内の部分範囲の開始位置を取得します。 |
isPartial() | Boolean | この範囲要素が要素全体または一部の文字をカバーしているかどうかを判断します。 |
詳細なドキュメント
getElement()
この RangeElement に対応する Element を取得します。
// 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.');
}
戻る
Element - この RangeElement に対応する要素
認可
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getEndOffsetInclusive()
範囲要素内の部分範囲の終点の位置を取得します。要素が Text 要素で、isPartial() が true を返す場合、オフセットは、範囲の最後の文字（つまり、範囲の最後の文字のインデックス）の文字数です。それ以外の場合、このメソッドは -1 を返します。
戻る
Integer - Text 要素の場合、範囲の最後の文字の前の文字数。他の要素の場合は -1。
認可
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getStartOffset()
範囲要素内の部分範囲の開始位置を取得します。要素が Text 要素で、isPartial() が true を返す場合、オフセットは範囲の開始前の文字数（つまり、範囲の最初の文字のインデックス）です。それ以外の場合、このメソッドは -1 を返します。
戻る
Integer - Text 要素の場合、範囲の開始前の文字数。他の要素の場合は、-1
認可
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
isPartial()
この範囲要素が要素全体または一部の文字をカバーしているかどうかを判断します。部分範囲要素の範囲の開始と終了は、それぞれ getStartOffset() と getEndOffsetInclusive() を使用して決定できます。
戻る
Boolean - 要素が部分的に含まれている場合は true、含まれていない場合は false
認可
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents