Compilateur utilisé pour créer des objets Range
à partir d'éléments de document.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addElement(element) | RangeBuilder | Ajoute un Element entier à ce RangeBuilder . |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | Ajoute un élément Text partiel à ce RangeBuilder . |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | Ajoute deux éléments entiers, ainsi que tous les éléments situés entre eux, à ce RangeBuilder . |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | Ajoute deux éléments Text partiels et tous les éléments situés entre eux à RangeBuilder . |
addRange(range) | RangeBuilder | Ajoute le contenu d'un autre élément Range à ce RangeBuilder . |
build() | Range | Construit un Range à partir des paramètres appliqués au compilateur. |
getRangeElements() | RangeElement[] | Récupère tous les éléments de ce Range , y compris les éléments Text partiels (par exemple, dans le cas d'une sélection qui n'inclut qu'une partie d'un élément Text ). |
Documentation détaillée
addElement(element)
Ajoute un Element
entier à ce RangeBuilder
.
Paramètres
Nom | Type | Description |
---|---|---|
element | Element | l'élément à ajouter |
Renvois
RangeBuilder
: ce compilateur, pour le chaînage
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
addElement(textElement, startOffset, endOffsetInclusive)
Ajoute un élément Text
partiel à ce RangeBuilder
.
Paramètres
Nom | Type | Description |
---|---|---|
textElement | Text | l'élément textuel à ajouter partiellement |
startOffset | Integer | Nombre de caractères avant le premier caractère à inclure (c'est-à-dire, l'index du premier caractère de la plage) |
endOffsetInclusive | Integer | Nombre de caractères avant le dernier caractère à inclure (c'est-à-dire, l'index du dernier caractère de la plage) |
Renvois
RangeBuilder
: ce compilateur, pour le chaînage
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
addElementsBetween(startElement, endElementInclusive)
Ajoute deux éléments entiers, ainsi que tous les éléments situés entre eux, à ce RangeBuilder
.
Paramètres
Nom | Type | Description |
---|---|---|
startElement | Element | le premier élément à ajouter |
endElementInclusive | Element | le dernier élément à ajouter |
Renvois
RangeBuilder
: ce compilateur, pour le chaînage
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
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)
Ajoute deux éléments Text
partiels et tous les éléments situés entre eux à RangeBuilder
.
Paramètres
Nom | Type | Description |
---|---|---|
startTextElement | Text | le premier élément de texte à ajouter partiellement |
startOffset | Integer | Nombre de caractères avant le premier caractère de startTextElement à inclure (c'est-à-dire, l'index du premier caractère de la plage) |
endTextElementInclusive | Text | le dernier élément de texte à ajouter partiellement |
endOffsetInclusive | Integer | Nombre de caractères avant le dernier caractère de endTextElementInclusive à inclure (c'est-à-dire, l'index du dernier caractère de la plage) |
Renvois
RangeBuilder
: ce compilateur, pour le chaînage
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
addRange(range)
Ajoute le contenu d'un autre élément Range
à ce RangeBuilder
.
Paramètres
Nom | Type | Description |
---|---|---|
range | Range | la plage dont les éléments doivent être ajoutés |
Renvois
RangeBuilder
: ce compilateur, pour le chaînage
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
build()
Construit un Range
à partir des paramètres appliqués au compilateur.
Renvois
Range
: plage nouvellement créée
getRangeElements()
Récupère tous les éléments de ce Range
, y compris les éléments Text
partiels (par exemple, dans le cas d'une sélection qui n'inclut qu'une partie d'un élément Text
). Pour déterminer si un élément Text
n'est que partiellement inclus dans la plage, consultez RangeElement.isPartial()
.
Renvois
RangeElement[]
: tableau d'éléments dans l'ordre dans lequel ils apparaissent dans le document
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