Cette page a été traduite par l'API Cloud Translation.

Class RangeBuilder

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
// active tab.
const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let 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 à cet élément `RangeBuilder`.
`addElementsBetween(startElement, endElementInclusive)`	`RangeBuilder`	Ajoute deux éléments entiers et tous les éléments situés entre eux à cette `RangeBuilder`.
`addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)`	`RangeBuilder`	Ajoute deux éléments `Text` partiels et tous les éléments situés entre eux au `RangeBuilder`.
`addRange(range)`	`RangeBuilder`	Ajoute le contenu d'un autre `Range` à ce `RangeBuilder`.
`build()`	`Range`	Crée un `Range` à partir des paramètres appliqués au compilateur.
`getRangeElements()`	`RangeElement[]`	Récupère tous les éléments de cet élément `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`).

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`getSelectedElements()`	`RangeElement[]`	Récupère tous les éléments que l'utilisateur a sélectionnés dans l'instance ouverte du document, y compris les éléments `Text` partiellement sélectionnés.

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 avec 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 à cet élément RangeBuilder.

Paramètres

Nom	Type	Description
`textElement`	`Text`	l'élément textuel à ajouter partiellement
`startOffset`	`Integer`	le nombre de caractères avant le premier caractère à inclure (c'est-à-dire l'index du premier caractère de la plage)
`endOffsetInclusive`	`Integer`	le nombre de caractères avant le dernier caractère à inclure (c'est-à-dire l'indice 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 avec 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 et tous les éléments situés entre eux à cette 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 avec 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 au RangeBuilder.

Paramètres

Nom	Type	Description
`startTextElement`	`Text`	le premier élément de texte à ajouter partiellement ;
`startOffset`	`Integer`	Nombre de caractères à inclure avant le premier caractère de `startTextElement` (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 à inclure avant le dernier caractère de `endTextElementInclusive` (c'est-à-dire l'indice 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 avec 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 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 avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`build()`

Crée 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 cet élément 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 avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

Méthodes obsolètes

`getSelectedElements()`

Obsolète. Nom remplacé par getRangeElements().

Récupère tous les éléments que l'utilisateur a sélectionnés dans l'instance ouverte du document, y compris les éléments Text partiellement sélectionnés.

Renvois

RangeElement[] : tableau d'éléments sélectionnés ou partiellement sélectionnés, dans l'ordre dans lequel ils apparaissent dans le document

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents