Un wrapper autour d'un Element
avec un décalage de début et de fin possible. Ces décalages permettent à
une plage de caractères comprise dans une Text
à représenter 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 le 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 les caractères de l'élément. |
Documentation détaillée
getElement()
Récupère le 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 correspondant à ce RangeElement
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 une
é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 toute autre
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 correspondant à 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 une
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 tout autre cas,
renvoie -1
.
Renvois
Integer
: pour les éléments Text
, le
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 correspondant à 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
les caractères de l'élément. Le début et la fin de la plage d'un élément de plage partielle peuvent être
déterminé à l'aide de getStartOffset()
et getEndOffsetInclusive()
, respectivement.
Renvois
Boolean
: true
si l'élément est partiellement inclus false
si ce n'est pas le cas
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents