Wrapper di sekitar Element
dengan kemungkinan offset awal dan akhir. Offset ini memungkinkan rentang karakter dalam elemen Text
untuk direpresentasikan dalam hasil penelusuran, pilihan dokumen, dan rentang bernama.
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
getElement() | Element | Mendapatkan Element yang sesuai dengan RangeElement ini. |
getEndOffsetInclusive() | Integer | Mendapatkan posisi akhir rentang parsial dalam elemen rentang. |
getStartOffset() | Integer | Mendapatkan posisi awal rentang parsial dalam elemen rentang. |
isPartial() | Boolean | Menentukan apakah elemen rentang ini mencakup seluruh elemen atau sebagian pilihan karakter elemen. |
Dokumentasi mendetail
getElement()
Mendapatkan Element
yang sesuai dengan RangeElement
ini.
// 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.'); }
Return
Element
— elemen yang sesuai dengan RangeElement
ini
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getEndOffsetInclusive()
Mendapatkan posisi akhir rentang parsial dalam elemen rentang. Jika elemen berupa elemen Text
dan isPartial()
menampilkan true
, offsetnya adalah jumlah karakter sebelum karakter terakhir dalam rentang (yaitu, indeks karakter terakhir dalam rentang); dalam kasus lainnya, metode ini akan menampilkan -1
.
Return
Integer
— untuk elemen Text
, jumlah
karakter sebelum karakter terakhir dalam rentang; untuk elemen lainnya, -1
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getStartOffset()
Mendapatkan posisi awal rentang parsial dalam elemen rentang. Jika elemen berupa elemen Text
dan isPartial()
menampilkan true
, offsetnya adalah jumlah karakter sebelum awal rentang (yaitu, indeks karakter pertama dalam rentang); dalam kasus lain, metode ini menampilkan -1
.
Return
Integer
— untuk elemen Text
, jumlah karakter sebelum awal rentang; untuk elemen lainnya, -1
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isPartial()
Menentukan apakah elemen rentang ini mencakup seluruh elemen atau sebagian pilihan
karakter elemen. Awal dan akhir rentang elemen rentang parsial dapat
ditentukan masing-masing menggunakan getStartOffset()
dan getEndOffsetInclusive()
.
Return
Boolean
— true
jika elemen disertakan sebagian; false
jika tidak
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents