Class RangeBuilder

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 partiel Text à ce RangeBuilder.
addElementsBetween(startElement, endElementInclusive)	RangeBuilder	Ajoute deux éléments entiers, ainsi que tous les éléments entre eux, à ce RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)	RangeBuilder	Ajoute deux éléments partiels Text, ainsi que tous les éléments 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[]	Obtient 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).

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
getSelectedElements()	RangeElement[]	Obtient 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é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 à ce RangeBuilder.

Paramètres

Nom	Type	Description
textElement	Text	élément de texte à 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 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, ainsi que tous les éléments entre eux, à ce RangeBuilder.

Paramètres

Nom	Type	Description
startElement	Element	premier élément à ajouter
endElementInclusive	Element	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, ainsi que tous les éléments entre eux, au RangeBuilder.

Paramètres

Nom	Type	Description
startTextElement	Text	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	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 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	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 : la plage nouvellement créée

---

getRangeElements()

Obtient 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 inclus que partiellement dans la plage, consultez RangeElement.isPartial().

Renvois

RangeElement[] : un tableau d'éléments, dans l'ordre où 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().

Obtient 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[] : un tableau d'éléments sélectionnés ou partiellement sélectionnés, dans l'ordre où 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