Un élément Range comportant 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 dans le même document peuvent partager le même nom, à la manière d'une classe en HTML. En revanche, les ID sont uniques dans le document, comme les ID HTML. Une fois qu'une propriété NamedRange a été ajoutée à un document, elle ne peut plus être modifiée. Elle a seulement été supprimée.
Tous les scripts qui accèdent au document peuvent accéder au document NamedRange. Pour éviter les conflits involontaires entre les scripts, pensez à ajouter un préfixe unique aux noms de plages.
// Create a named 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.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());
Méthodes
| Méthode | Type renvoyé | Brève description |
|---|---|---|
getId() | String | Récupère l'ID de NamedRange. |
getName() | String | Récupère le nom de cet élément NamedRange. |
getRange() | Range | Récupère la plage d'éléments associée à cet objet NamedRange. |
remove() | void | Supprime NamedRange du document. |
Documentation détaillée
getId()
Récupère l'ID de NamedRange. L'identifiant est unique dans le document.
Aller-retour
String : ID de la plage, qui est unique dans le document
getName()
Récupère le nom de cet élément NamedRange. Le nom n'est pas nécessairement unique.
Aller-retour
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ée à cet objet NamedRange.
Aller-retour
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 NamedRange du document. Cette méthode ne supprime pas le contenu de la plage, mais 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