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