Class RangeBuilder

RangeBuilder

用于根据文档元素构建 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向此 RangeBuilder 添加整个 Element
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilder向此 RangeBuilder 添加部分 Text 元素。
addElementsBetween(startElement, endElementInclusive)RangeBuilder向此 RangeBuilder 添加两个整个元素及其之间的所有元素。
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderRangeBuilder 添加两个部分 Text 元素及其之间的所有元素。
addRange(range)RangeBuilder将另一个 Range 的内容添加到此 RangeBuilder
build()Range通过应用于构建器的设置构造 Range
getRangeElements()RangeElement[]获取此 Range 中的所有元素,包括任何部分 Text 元素(例如,如果所选内容中仅包含 Text 元素的一部分)。

详细文档

addElement(element)

向此 RangeBuilder 添加整个 Element

参数

名称类型说明
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)

RangeBuilder 添加两个部分 Text 元素及其之间的所有元素。

参数

名称类型说明
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

已废弃的方法