Class NamedRange

Plage nommée

Range avec un nom et un ID permettant de le récupérer ultérieurement. Les noms ne sont pas nécessairement uniques. Plusieurs plages différentes d'un même onglet peuvent porter le même nom, comme une classe en HTML. En revanche, les ID sont uniques dans l'onglet, comme un ID en HTML. Une fois qu'une NamedRange a été ajoutée à un onglet, elle ne peut plus être modifiée, mais seulement supprimée.

Un NamedRange est accessible par n'importe quel script qui accède à l'onglet. Pour éviter les conflits involontaires entre les scripts, envisagez d'ajouter un préfixe unique aux noms de plage.

// Create a named range that includes every table in the active tab.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());

Méthodes

Méthode	Type renvoyé	Brève description
getId()	String	Récupère l'ID de cet objet NamedRange.
getName()	String	Récupère le nom de cet objet NamedRange.
getRange()	Range	Récupère la plage d'éléments associés à cette NamedRange.
remove()	void	Supprime cet NamedRange de l'onglet.

Documentation détaillée

getId()

Récupère l'ID de cet objet NamedRange. L'ID est unique dans l'onglet.

Renvois

String : ID de la plage, qui est unique dans l'onglet.

---

getName()

Récupère le nom de cet objet NamedRange. Le nom n'est pas nécessairement unique.

Renvois

String : nom de la plage, qui n'est pas nécessairement unique.

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

---

getRange()

Récupère la plage d'éléments associés à cette NamedRange.

Renvois

Range : plage d'éléments associés au nom et à l'ID.

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

---

remove()

Supprime cet NamedRange de l'onglet. Cette méthode ne supprime pas le contenu de la plage, mais supprime simplement la référence. L'appel de cette méthode sur un NamedRange déjà supprimé n'a aucun effet.

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