Um wrapper em torno de uma Element
com possíveis deslocamentos de início e término. Esses deslocamentos permitem que uma
intervalo de caracteres em uma Text
seja representado nos resultados da pesquisa, nas seleções de documentos e nos intervalos nomeados.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getElement() | Element | Recebe o Element que corresponde a esse RangeElement . |
getEndOffsetInclusive() | Integer | Recupera a posição do final de um intervalo parcial dentro do elemento de intervalo. |
getStartOffset() | Integer | Recupera a posição do início de um intervalo parcial dentro do elemento de intervalo. |
isPartial() | Boolean | Determina se este elemento de intervalo cobre o elemento inteiro ou uma seleção parcial do os caracteres do elemento. |
Documentação detalhada
getElement()
Recebe o Element
que corresponde a esse RangeElement
.
// 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.'); }
Retornar
Element
: o elemento que corresponde a esse RangeElement
.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getEndOffsetInclusive()
Recupera a posição do final de um intervalo parcial dentro do elemento de intervalo. Se o elemento for uma
O elemento Text
e isPartial()
retornam true
, o deslocamento é o número de caracteres antes do último
no intervalo (ou seja, o índice do último caractere do intervalo); em qualquer outro
caso, esse método retorna -1
.
Retornar
Integer
: para os elementos Text
, os
número de caracteres antes do último caractere no intervalo para outros elementos, -1
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getStartOffset()
Recupera a posição do início de um intervalo parcial dentro do elemento de intervalo. Se o elemento for uma
O elemento Text
e isPartial()
retornam true
, o deslocamento é o número de caracteres antes do início do
o intervalo (ou seja, o índice do primeiro caractere no intervalo); em qualquer outro caso,
retorna -1
.
Retornar
Integer
: para os elementos Text
, os
número de caracteres antes do início do intervalo; para outros elementos, -1
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isPartial()
Determina se este elemento de intervalo cobre o elemento inteiro ou uma seleção parcial do
os caracteres do elemento. O início e o fim do intervalo de um elemento de intervalo parcial podem ser
são determinados usando getStartOffset()
e getEndOffsetInclusive()
, respectivamente.
Retornar
Boolean
: true
se o elemento estiver parcialmente incluído. false
se não for
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents