Class RangeBuilder

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)RangeBuilderこの RangeBuilder に 2 つの要素全体とそれらの間のすべての要素を追加します。
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderこの RangeBuilder に 2 つの Text 要素の一部とそれらの間のすべての要素を追加します。
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)

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

パラメータ

名前タイプ説明
startElementElement追加する最初の要素
endElementInclusiveElement追加する最後の要素

戻る

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

承認

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

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

この RangeBuilder に 2 つの Text 要素の一部とそれらの間のすべての要素を追加します。

パラメータ

名前タイプ説明
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

サポート終了のメソッド