Class RangeElement

RangeElement

Element 的封装容器，具有可能的起始偏移量和结束偏移量。这些偏移允许 Text 中的字符范围 元素。

方法

方法	返回类型	简介
getElement()	Element	获取与此 RangeElement 对应的 Element。
getEndOffsetInclusive()	Integer	获取范围元素内部分范围的结束位置。
getStartOffset()	Integer	获取范围元素中部分范围的起始位置。
isPartial()	Boolean	确定此范围元素是涵盖整个元素还是涵盖 元素的字符。

详细文档

getElement()

获取与此 RangeElement 对应的 Element。

// Log debug information about a range element.
Logger.log('Element type: ' + rangeElement.getElement().getType());
if (rangeElement.isPartial()) {
  Logger.log('The character range begins at ' + rangeElement.getStartOffset());
  Logger.log('The character range ends at ' + rangeElement.getEndOffsetInclusive());
} else {
  Logger.log('The entire range element is included.');
}

返回

Element - 与此 RangeElement 对应的元素

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

getEndOffsetInclusive()

获取范围元素内部分范围的结束位置。如果元素为 Text 元素且 isPartial() 返回 true，偏移量是最后一个 范围内的字符（即范围内最后一个字符的索引）；在任何其他 在这种情况下，此方法会返回 -1。

返回

Integer - 对于 Text 元素， 范围内最后一个字符前的字符数；对于其他元素，-1

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

getStartOffset()

获取范围元素中部分范围的起始位置。如果元素为 Text 元素且 isPartial() 返回 true，则偏移量是 范围（即范围内第一个字符的索引）；在任何其他情况下 方法会返回 -1。

返回

Integer - 对于 Text 元素， 范围起始前的字符数；对于其他元素，-1

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

isPartial()

确定此范围元素是涵盖整个元素还是涵盖 元素的字符。部分范围元素范围的开头和结尾可以是 分别使用 getStartOffset() 和 getEndOffsetInclusive() 确定。

返回

Boolean - 如果元素被部分包含，则为 true；如果不是，则为 false

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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