Class RangeElement

RangeElement

開始オフセットと終了オフセットを含む 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