Un wrapper attorno a un Element con un possibile offset di inizio e fine. Questi offset consentono di rappresentare un intervallo di caratteri all'interno di un elemento Text nei risultati di ricerca, nelle selezioni dei documenti e negli intervalli denominati.
Metodi
| Metodo | Tipo restituito | Breve descrizione |
|---|---|---|
getElement() | Element | Restituisce il Element che corrisponde a questo RangeElement. |
getEndOffsetInclusive() | Integer | Restituisce la posizione della fine di un intervallo parziale all'interno dell'elemento dell'intervallo. |
getStartOffset() | Integer | Restituisce la posizione di inizio di un intervallo parziale all'interno dell'elemento dell'intervallo. |
isPartial() | Boolean | Determina se questo elemento dell'intervallo copre l'intero elemento o una selezione parziale dei caratteri dell'elemento. |
Documentazione dettagliata
getElement()
Restituisce il Element che corrisponde a questo 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.');
}
Ritorni
Element: l'elemento che corrisponde a questo RangeElement
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getEndOffsetInclusive()
Restituisce la posizione della fine di un intervallo parziale all'interno dell'elemento dell'intervallo. Se l'elemento è un elemento Text e isPartial() restituisce true, l'offset è il numero di caratteri che precede l'ultimo carattere dell'intervallo (ossia l'indice dell'ultimo carattere dell'intervallo). In tutti gli altri casi, questo metodo restituisce -1.
Ritorni
Integer: per gli elementi Text, il numero di caratteri prima dell'ultimo carattere dell'intervallo; per altri elementi, -1
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getStartOffset()
Restituisce la posizione di inizio di un intervallo parziale all'interno dell'elemento dell'intervallo. Se l'elemento è un elemento Text e isPartial() restituisce true, l'offset corrisponde al numero di caratteri che precede l'inizio dell'intervallo (ovvero l'indice del primo carattere dell'intervallo). In tutti gli altri casi, questo metodo restituisce -1.
Ritorni
Integer: per gli elementi Text, il numero di caratteri prima dell'inizio dell'intervallo; per gli altri elementi, -1
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
isPartial()
Determina se questo elemento dell'intervallo copre l'intero elemento o una selezione parziale dei
caratteri dell'elemento. L'inizio e la fine dell'intervallo di un elemento intervallo parziale possono essere determinati utilizzando rispettivamente getStartOffset() e getEndOffsetInclusive().
Ritorni
Boolean: true se l'elemento è parzialmente incluso; false in caso contrario
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents