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將整個 Element 新增至這個 RangeBuilder。
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilder在這個 RangeBuilder 中加入部分 Text 元素。
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)

在這個 RangeBuilder 中加入部分 Text 元素。

參數

名稱類型說明
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

已淘汰的方法