Class RangeBuilder

範囲ビルダー

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

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

メソッド

メソッド戻り値の型概要
addElement(element)RangeBuilderこの RangeBuilder に Element 全体を追加します。
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)

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

パラメータ

名前型説明
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()

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

戻る

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

承認

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

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

サポート終了のメソッド