ドキュメント要素から 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());
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
add | Range | この Range に Element 全体を追加します。 |
add | Range | この Range に部分的な Text 要素を追加します。 |
add | Range | 2 つの要素全体と、それらの間にあるすべての要素をこの Range に追加します。 |
add | Range | 2 つの部分的な Text 要素と、それらの間にあるすべての要素を Range に追加します。 |
add | Range | 別の Range の内容をこの Range に追加します。 |
build() | Range | ビルダーに適用された設定から Range を作成します。 |
get | Range | この Range 内のすべての要素を取得します。部分的な Text 要素も取得します(Text 要素の一部のみを含む選択の場合など)。 |
詳細なドキュメント
add Element(element)
この Range
に Element
全体を追加します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
element | Element | 追加する要素 |
戻る
Range
- チェーン用のこのビルダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Element(textElement, startOffset, endOffsetInclusive)
この Range
に部分的な Text
要素を追加します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | Text | 部分的に追加するテキスト要素 |
start | Integer | 含める最初の文字の前の文字数(範囲内の最初の文字のインデックス) |
end | Integer | 含める最後の文字の前の文字数(範囲内の最後の文字のインデックス) |
戻る
Range
- チェーン用のこのビルダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Elements Between(startElement, endElementInclusive)
2 つの要素全体と、それらの間にあるすべての要素をこの Range
に追加します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Element | 最初に追加される要素 |
end | Element | 最後に追加される要素 |
戻る
Range
- チェーン用のこのビルダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Elements Between(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)
2 つの部分的な Text
要素と、それらの間にあるすべての要素を Range
に追加します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Text | 部分的に追加される最初のテキスト要素 |
start | Integer | 含める start の最初の文字の前の文字数(範囲内の最初の文字のインデックス) |
end | Text | 部分的に追加された最後のテキスト要素 |
end | Integer | 含める end の最後の文字の前の文字数(範囲内の最後の文字のインデックス) |
戻る
Range
- チェーン用のこのビルダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Range(range)
別の Range
の内容をこの Range
に追加します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
range | Range | 要素を追加する範囲 |
戻る
Range
- チェーン用のこのビルダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
build()
get Range Elements()
この Range
内のすべての要素を取得します。部分的な Text
要素も取得されます(Text
要素の一部のみを含む選択の場合など)。Text
要素が範囲に部分的にのみ含まれているかどうかを確認するには、Range
をご覧ください。
戻る
Range
- ドキュメントに表示される順序で並べられた要素の配列
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents