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	將部分 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 元素的情況)。

已淘汰的方法

方法	傳回類型	簡短說明
getSelectedElements()	RangeElement[]	取得使用者在開啟的文件例項中選取的所有元素，包括任何部分選取的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()

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

回攻員

Range：新建立的範圍

---

getRangeElements()

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

回攻員

RangeElement[]：元素陣列，順序與元素在文件中的顯示順序相同

授權

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

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

已淘汰的方法

getSelectedElements()

已淘汰。已重新命名為「getRangeElements()」。

取得使用者在開啟的文件例項中選取的所有元素，包括任何部分選取的Text元素。

回攻員

RangeElement[]：所選或部分選取元素的陣列，順序與元素在文件中顯示的順序相同

授權

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

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