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この 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[]Text の部分的な要素を含むすべての Range 要素を取得します（たとえば、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部分的に追加する最初のテキスト要素
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()

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

戻る

RangeElement[] - ドキュメントに表示される順序で要素の配列

認可

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

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

サポート終了のメソッド