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