Class RangeBuilder

RangeBuilder

用於透過文件元素建構 Range 物件的建構工具。 

// Change the user's selection to a range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.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。

參數

名稱類型說明
elementElement要新增的元素

回攻員

RangeBuilder：這個建構工具用於鏈結

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

addElement(textElement, startOffset, endOffsetInclusive)

將部分 Text 元素新增至此 RangeBuilder。

參數

名稱類型說明
textElementText要新增部分的文字元素
startOffsetInteger要加進的第一個字元前的字元數 (也就是 範圍內第一個字元的索引)
endOffsetInclusiveInteger要包含的最後一個字元前的字元數 (也就是範圍中最後一個字元的索引)

回攻員

RangeBuilder：這個建構工具用於鏈結

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

addElementsBetween(startElement, endElementInclusive)

將兩個整個元素和兩者之間的所有元素加入此 RangeBuilder。

參數

名稱類型說明
startElementElement要新增的第一個元素
endElementInclusiveElement最後要新增的元素

回攻員

RangeBuilder：這個建構工具用於鏈結

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

將兩個部分 Text 元素及其之間的所有元素新增至 RangeBuilder。

參數

名稱類型說明
startTextElementText要部分新增的第一個文字元素
startOffsetInteger要納入 startTextElement 第一個字元前的字元數 (也就是範圍中第一個字元的索引)
endTextElementInclusiveText最後一個要新增部分的文字元素
endOffsetInclusiveInteger要納入 endTextElementInclusive 中最後一個字元前的字元數量 (也就是最後一個字元的索引) 範圍)

回攻員

RangeBuilder：這個建構工具用於鏈結

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

addRange(range)

將另一個 Range 的內容新增至此 RangeBuilder。

參數

名稱類型說明
rangeRange應該新增元素的範圍

回攻員

RangeBuilder：這個建構工具用於鏈結

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

build()

根據套用至建構工具的設定建構 Range。

回攻員

Range：新建構的範圍

getRangeElements()

取得這個 Range 中的所有元素，包括任何部分 Text 元素 (例如 只含有部分 Text 元素的選擇範圍)。如要判斷 Text 元素只有部分包含在範圍中，請參閱 RangeElement.isPartial()。

回攻員

RangeElement[]：元素的陣列，依照元素在文件中顯示的順序

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

已淘汰的方法