Wrapper autour d'un Element avec des décalages de début et de fin possibles. Ces décalages permettent de représenter une plage de caractères d'un élément Text dans les résultats de recherche, les sélections de documents et les plages nommées.
Méthodes
| Méthode | Type renvoyé | Brève description |
|---|---|---|
getElement() | Element | Récupère les Element correspondant à ce RangeElement. |
getEndOffsetInclusive() | Integer | Récupère la position de la fin d'une plage partielle dans l'élément de plage. |
getStartOffset() | Integer | Récupère la position du début d'une plage partielle dans l'élément de plage. |
isPartial() | Boolean | Détermine si cet élément de plage couvre l'intégralité de l'élément ou une sélection partielle de ses caractères. |
Documentation détaillée
getElement()
Récupère les Element correspondant à ce 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.');
}
Renvois
Element : élément qui correspond à ce RangeElement
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getEndOffsetInclusive()
Récupère la position de la fin d'une plage partielle dans l'élément de plage. Si l'élément est un élément Text et que isPartial() renvoie true, le décalage correspond au nombre de caractères avant le dernier caractère de la plage (c'est-à-dire, l'index du dernier caractère de la plage). Dans tous les autres cas, cette méthode renvoie -1.
Renvois
Integer : pour les éléments Text, le nombre de caractères avant le dernier caractère de la plage ; pour les autres éléments, -1
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getStartOffset()
Récupère la position du début d'une plage partielle dans l'élément de plage. Si l'élément est un élément Text et que isPartial() renvoie true, le décalage correspond au nombre de caractères avant le début de la plage (c'est-à-dire l'index du premier caractère de la plage). Dans tous les autres cas, cette méthode renvoie -1.
Renvois
Integer : pour les éléments Text, le nombre de caractères avant le début de la plage ; pour les autres éléments, -1
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
isPartial()
Détermine si cet élément de plage couvre l'intégralité de l'élément ou une sélection partielle de ses caractères. Le début et la fin de la plage d'un élément de plage partielle peuvent être déterminés respectivement à l'aide de getStartOffset() et de getEndOffsetInclusive().
Renvois
Boolean : true si l'élément est partiellement inclus ; false dans le cas contraire.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents