方法
方法 | 返回类型 | 简介 |
---|---|---|
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