Class RangeBuilder

RangeBuilder

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

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

メソッド

メソッド戻り値の型概要
addElement(element)RangeBuilderElement 全体をこの RangeBuilder に追加します。
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderこの RangeBuilder に部分的な Text 要素を追加します。
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)

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

パラメータ

名前型説明
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部分的に追加する最初のテキスト要素です。
startOffsetIntegerstartTextElement の先頭文字までの文字数（範囲内の最初の文字のインデックス）
endTextElementInclusiveText部分的に追加される最後のテキスト要素
endOffsetInclusiveIntegerendTextElementInclusive の最後の文字より前の文字数（つまり、 範囲）

戻る

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

サポート終了のメソッド