Class RangeBuilder

RangeBuilder

ドキュメントの要素から Range オブジェクトを作成するために使用されるビルダー。 

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Methods

メソッド戻り値の型概要
addElement(element)RangeBuilderElement 全体をこの RangeBuilder に追加します。
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilder部分的な Text 要素をこの RangeBuilder に追加します。
addElementsBetween(startElement, endElementInclusive)RangeBuilder2 つの要素全体と、それらの間のすべての要素をこの RangeBuilder に追加します。
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilder2 つの部分的な Text 要素と、それらの間のすべての要素を RangeBuilder に追加します。
addRange(range)RangeBuilder別の Range の内容をこの RangeBuilder に追加します。
build()Rangeビルダーに適用された設定から Range を作成します。
getRangeElements()RangeElement[]この Range 内のすべての要素（部分的な Text 要素を含む）を取得します（たとえば、Text 要素の一部のみを含む選択の場合）。

詳細なドキュメント

addElement(element)

Element 全体をこの RangeBuilder に追加します。

パラメータ

名前型説明
elementElement追加する要素です

リターン

RangeBuilder - このビルダー（チェーン用）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addElement(textElement, startOffset, endOffsetInclusive)

部分的な Text 要素をこの RangeBuilder に追加します。

パラメータ

名前型説明
textElementText部分的に追加されるテキスト要素です
startOffsetInteger最初の文字の前に含める文字数（つまり、範囲内の最初の文字のインデックス）
endOffsetInclusiveInteger含める最後の文字までの文字数（つまり、範囲内の最後の文字のインデックス）

リターン

RangeBuilder - このビルダー（チェーン用）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addElementsBetween(startElement, endElementInclusive)

2 つの要素全体と、それらの間のすべての要素をこの RangeBuilder に追加します。

パラメータ

名前型説明
startElementElement最初の要素を追加します
endElementInclusiveElement追加する最後の要素です

リターン

RangeBuilder - このビルダー（チェーン用）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

2 つの部分的な Text 要素と、それらの間のすべての要素を RangeBuilder に追加します。

パラメータ

名前型説明
startTextElementText部分的に追加される最初のテキスト要素
startOffsetInteger含める startTextElement の最初の文字の前の文字数（つまり、範囲の最初の文字のインデックス）
endTextElementInclusiveText部分的に追加される最後のテキスト要素
endOffsetInclusiveInteger含める endTextElementInclusive の最後の文字の前の文字数（つまり、範囲の最後の文字のインデックス）

リターン

RangeBuilder - このビルダー（チェーン用）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addRange(range)

別の Range の内容をこの RangeBuilder に追加します。

パラメータ

名前型説明
rangeRange要素を追加する範囲です

リターン

RangeBuilder - このビルダー（チェーン用）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

build()

ビルダーに適用された設定から Range を作成します。

リターン

Range - 新しく作成された範囲

getRangeElements()

この Range 内のすべての要素（部分的な Text 要素を含む）を取得します（たとえば、Text 要素の一部のみを含む選択の場合）。Text 要素が範囲の一部のみに含まれているかどうかを判断するには、RangeElement.isPartial() をご覧ください。

リターン

RangeElement[] - 要素の配列（ドキュメント内での表示順序）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

サポート終了のメソッド