Class RangeElement

範囲要素

開始オフセットと終了オフセットが可能な Element のラッパー。これらのオフセットを使用すると、Text 要素内の文字範囲を検索結果、ドキュメント選択、名前付き範囲で表すことができます。

メソッド

メソッド戻り値の型概要
getElement()Elementこの RangeElement に対応する Element を取得します。
getEndOffsetInclusive()Integer範囲要素内の部分範囲の終了位置を取得します。
getStartOffset()Integer範囲要素内の部分範囲の開始位置を取得します。
isPartial()Booleanこの範囲要素が要素全体を対象とするのか、要素の文字の一部を選択するのかを指定します。

詳細なドキュメント

getElement()

この RangeElement に対応する Element を取得します。

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.');
}

戻る

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