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