Class RangeElement

Range 元素

封装了 Element 的封装容器，可能具有开始偏移量和结束偏移量。借助这些偏移，Text 元素中的一组字符可以在搜索结果、文档选择和命名范围中表示。

方法

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

详细文档

getElement()

获取与此 RangeElement 相对应的 Element。 

const rangeElement = DocumentApp.getActiveDocument().getSelection().getRangeElements()[0];

// 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