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 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éthodeType renvoyéBrève description
addElement(element)RangeBuilderAjoute un Element entier à ce RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderAjoute un élément Text partiel à ce RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAjoute deux éléments entiers, ainsi que tous les éléments situés entre eux, à ce RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAjoute deux éléments Text partiels et tous les éléments situés entre eux à RangeBuilder.
addRange(range)RangeBuilderAjoute le contenu d'un autre élément Range à ce RangeBuilder.
build()RangeConstruit 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

NomTypeDescription
elementElementl'é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

NomTypeDescription
textElementTextl'élément textuel à ajouter partiellement
startOffsetIntegerNombre de caractères avant le premier caractère à inclure (c'est-à-dire, l'index du premier caractère de la plage)
endOffsetInclusiveIntegerNombre 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

NomTypeDescription
startElementElementle premier élément à ajouter
endElementInclusiveElementle 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

NomTypeDescription
startTextElementTextle premier élément de texte à ajouter partiellement
startOffsetIntegerNombre de caractères avant le premier caractère de startTextElement à inclure (c'est-à-dire, l'index du premier caractère de la plage)
endTextElementInclusiveTextle dernier élément de texte à ajouter partiellement
endOffsetInclusiveIntegerNombre 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

NomTypeDescription
rangeRangela 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

Méthodes obsolètes