Class NamedRange

NamedRange

Un élément 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 document peuvent partager le même nom, à l'instar d'une classe en HTML. En revanche, les identifiants sont uniques au sein d'un document, tout comme les identifiants en HTML. Une fois qu'un NamedRange a été ajouté à un document, il ne peut plus être modifié, mais simplement supprimé.

Un NamedRange est accessible par tout script qui accède au document. Pour éviter les conflits involontaires entre les scripts, envisagez de préfixer les noms de plage avec une chaîne unique.

// 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éthodeType renvoyéBrève description
getId()StringRécupère l'ID de ce NamedRange.
getName()StringRécupère le nom de ce NamedRange.
getRange()RangeRécupère la plage d'éléments associée à ce NamedRange.
remove()voidSupprime ce NamedRange du document.

Documentation détaillée

getId()

Récupère l'ID de ce NamedRange. L'identifiant est unique au sein du document.

Renvois

String : ID de la plage, qui est unique dans le document


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 associée à 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 à 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 associée à 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 du document. Cette méthode ne supprime pas le contenu de la plage, elle supprime simplement la référence. Appeler 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 associée à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents