方法
方法 | 返回类型 | 简介 |
---|---|---|
get | Element | 获取与此 Range 相对应的 Element 。 |
get | Integer | 获取范围元素中部分范围的结束位置。 |
get | Integer | 获取范围元素中部分范围的起始位置。 |
is | Boolean | 确定此范围元素是涵盖整个元素,还是仅涵盖元素字符的部分选择。 |
详细文档
get Element()
获取与此 Range
相对应的 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
- 与此 Range
对应的元素
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get End Offset Inclusive()
获取范围元素中部分范围的结束位置。如果元素是 Text
元素,并且 is
返回 true
,则偏移量为范围中最后一个字符之前的字符数(即范围中最后一个字符的索引);在任何其他情况下,此方法都会返回 -1
。
返回
Integer
- 对于 Text
元素,是范围中最后一个字符之前的字符数;对于其他元素,为 -1
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Start Offset()
获取范围元素中部分范围的起始位置。如果元素是 Text
元素,并且 is
返回 true
,则偏移量为范围开始之前的字符数(即范围中第一个字符的索引);在任何其他情况下,此方法都会返回 -1
。
返回
Integer
- 对于 Text
元素,是范围开始前面的字符数;对于其他元素,是 -1
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is Partial()
确定此范围元素是涵盖整个元素,还是仅涵盖元素字符的部分选择。您可以分别使用 get
和 get
确定部分范围元素范围的开始和结束。
返回
Boolean
- 如果部分包含该元素,则为 true
;如果不包含,则为 false
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents