方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
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