Class NamedRange

NamedRange

Une Range qui possède un nom et un ID pour permettre une récupération ultérieure. Les noms ne sont pas nécessairement uniques. Plusieurs plages différentes dans le même onglet peuvent partager 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 pas être modifiée, mais uniquement supprimée.

Une NamedRange est accessible par n'importe quel script qui accède à l'onglet. Pour éviter les conflits involontaires entre les scripts, envisagez de préfixer les noms de plages avec une chaîne unique. 

// 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éthodeType renvoyéBrève description
getId()StringObtient l'ID de cette NamedRange.
getName()StringObtient le nom de ce NamedRange.
getRange()RangeObtient la plage d'éléments associée à cette NamedRange.
remove()voidSupprime ce NamedRange de l'onglet.

Documentation détaillée

getId()

Obtient l'ID de cette NamedRange. L'ID est unique dans l'onglet.

Renvois

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

getName()

Obtient le nom de cette 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()

Obtient la plage d'éléments associée à cette NamedRange.

Renvois

Range : plage d'éléments associée 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 cette NamedRange de l'onglet. Cette méthode ne supprime pas le contenu de la plage, mais uniquement la référence. L'appel de cette méthode sur une NamedRange qui a déjà été supprimée 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