這個建構工具可從文件元素建構 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());
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
addElement(element) | RangeBuilder | 將整個 Element 新增至此 RangeBuilder 。 |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | 將部分 Text 元素新增至這個 RangeBuilder 。 |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | 將兩個完整元素,以及兩個元素之間的所有元素新增至此 RangeBuilder 。 |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | 將兩個部分 Text 元素,以及兩個元素之間的所有元素新增至 RangeBuilder 。 |
addRange(range) | RangeBuilder | 將其他 Range 的內容新增至此 RangeBuilder 。 |
build() | Range | 根據套用至建構工具的設定建構 Range 。 |
getRangeElements() | RangeElement[] | 取得這個 Range 中的所有元素,包括任何部分 Text 元素 (例如,如果選取項目只包含部分 Text 元素)。 |
內容詳盡的說明文件
addElement(element)
將整個 Element
新增至此 RangeBuilder
。
參數
名稱 | 類型 | 說明 |
---|---|---|
element | Element | 要新增的元素 |
回攻員
RangeBuilder
:這個建構工具用於鏈結
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElement(textElement, startOffset, endOffsetInclusive)
將部分 Text
元素新增至這個 RangeBuilder
。
參數
名稱 | 類型 | 說明 |
---|---|---|
textElement | Text | 要部分新增的文字元素 |
startOffset | Integer | 要納入的第一個字元前的字元數 (也就是範圍內第一個字元的索引) |
endOffsetInclusive | Integer | 要納入最後一個字元之前的字元數 (也就是範圍內最後一個字元的索引) |
回攻員
RangeBuilder
:這個建構工具用於鏈結
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElementsBetween(startElement, endElementInclusive)
將兩個完整元素,以及兩個元素之間的所有元素新增至此 RangeBuilder
。
參數
名稱 | 類型 | 說明 |
---|---|---|
startElement | Element | 要加入的第一個元素 |
endElementInclusive | Element | 最後一個要新增的元素 |
回攻員
RangeBuilder
:這個建構工具用於鏈結
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)
將兩個部分 Text
元素,以及兩個元素之間的所有元素新增至 RangeBuilder
。
參數
名稱 | 類型 | 說明 |
---|---|---|
startTextElement | Text | 第一個要新增的第一個文字元素 |
startOffset | Integer | 要納入 startTextElement 第一個字元前的字元數 (也就是範圍內第一個字元的索引) |
endTextElementInclusive | Text | 最後一個要新增的部分文字元素 |
endOffsetInclusive | Integer | 要納入 endTextElementInclusive 最後一個字元之前的字元數 (也就是範圍內最後一個字元的索引) |
回攻員
RangeBuilder
:這個建構工具用於鏈結
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addRange(range)
將其他 Range
的內容新增至此 RangeBuilder
。
參數
名稱 | 類型 | 說明 |
---|---|---|
range | Range | 應加入其元素的範圍 |
回攻員
RangeBuilder
:這個建構工具用於鏈結
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
build()
getRangeElements()
取得這個 Range
中的所有元素,包括任何部分 Text
元素 (例如,如果選取項目只包含部分 Text
元素)。如要判斷 Text
元素是否僅部分納入範圍內,請參閱 RangeElement.isPartial()
。
回攻員
RangeElement[]
:元素陣列,依照元素在文件中的順序排列
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents