Une Range avec un nom et un ID pour permettre une récupération ultérieure. Les noms ne sont pas
nécessairement uniques ; plusieurs plages d'un même onglet peuvent avoir le même nom, à la manière
en HTML. En revanche, les ID sont uniques dans l'onglet, comme c'est le cas en HTML. Une fois qu'un NamedRange a été ajouté à un onglet, il ne peut pas être modifié, mais seulement supprimé.
Un NamedRange est accessible par n'importe quel script qui accède à l'onglet. Pour éviter les actions involontaires
des conflits entre les scripts, envisagez de faire précéder les noms de plage par une chaîne unique.
// Create a named range that includes every table in the active tab.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var 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 ce NamedRange. |
getName() | String | Récupère le nom de ce NamedRange. |
getRange() | Range | Récupère la plage d'éléments associés à ce NamedRange. |
remove() | void | Supprime ce NamedRange de l'onglet. |
Documentation détaillée
getId()
Récupère l'ID de ce NamedRange. Cet identifiant est unique dans l'onglet.
Renvois
String : ID de la plage, qui est unique dans l'onglet.
getName()
Récupère le nom de ce 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 correspondant à 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 à ce 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 correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove()
Supprime ce NamedRange de l'onglet. Cette méthode ne supprime pas le contenu
range; cela supprime simplement la référence. En appelant cette méthode sur un NamedRange qui
a déjà été supprimé n'a aucun effet.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents