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