Class NamedRange

PlageNommée

Créez, consultez et modifiez des plages nommées dans une feuille de calcul. Les plages nommées sont des plages d'alias de chaîne. Vous pouvez les afficher et les modifier dans l'interface utilisateur de Sheets, à partir du menu Données et plages ;

Méthodes

MéthodeType renvoyéBrève description
getName()StringRécupère le nom de la plage nommée.
getRange()RangeRécupère la plage référencée par cette plage nommée.
remove()voidSupprime cette plage nommée.
setName(name)NamedRangeDéfinit/met à jour le nom de la plage nommée.
setRange(range)NamedRangeDéfinit/met à jour la plage de cette plage nommée.

Documentation détaillée

getName()

Récupère le nom de la plage nommée.

Aller-retour

String : nom de la plage nommée

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/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

Récupère la plage référencée par cette plage nommée.

Aller-retour

Range : plage de feuilles de calcul associée à cette plage nommée

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/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

Supprime cette plage nommée.

// The code below deletes all the named ranges in the spreadsheet.
var namedRanges = SpreadsheetApp.getActive().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  namedRanges[i].remove();
}

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/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setName(name)

Définit/met à jour le nom de la plage nommée.

// The code below updates the name for the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
if (namedRanges.length > 1) {
  namedRanges[0].setName("UpdatedNamedRange");
}

Paramètres

NomTypeDescription
nameStringNouveau nom de la plage nommée.

Aller-retour

NamedRange : plage dont le nom a été défini par l'appel

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/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRange(range)

Définit/met à jour la plage de cette plage nommée.

Paramètres

NomTypeDescription
rangeRangePlage de feuilles de calcul à associer à cette plage nommée.

Aller-retour

NamedRange : plage nommée pour laquelle la plage de la feuille de calcul a été définie

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/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets