ExcelScript.NamedItem interface

Paquet:

ExcelScript

Représente un nom défini pour une plage de cellules ou une valeur. Les noms peuvent être des objets nommés primitifs (comme indiqué dans le type ci-dessous), un objet de plage ou une référence à une plage. Cet objet peut être utilisé pour obtenir l’objet de plage associé à des noms.

Remarques

Exemples

/**
 * This script creates a named formula and uses it in another part of the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a named item for a formula.
  // This formula is the sum of the cells F2:F21 on Sheet1.
  const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
    "GrandTotal", 
    "=SUM(Sheet1!$F$2:$F$21)", 
    "The sum of table sums."
  );

  // Add this named formula to a new sheet in the workbook.
  const otherSheet = workbook.addWorksheet();
  otherSheet.getRange("A1").setFormula(namedItem.getFormula());

  // Switch to the new worksheet.
  otherSheet.activate();
}

Méthodes

delete()	Supprime le nom donné.
getArrayValues()	Renvoie un objet contenant les valeurs et les types de l’élément nommé.
getComment()	Spécifie le commentaire associé à ce nom.
getFormula()	Formule de l’élément nommé. Les formules commencent toujours par un signe égal (« = »).
getName()	Nom de l’objet.
getRange()	Renvoie l’objet de plage qui est associé au nom. Si le type de l’élément nommé n’est pas une plage, cette méthode retourne undefined.
getScope()	Spécifie si le nom est limité au classeur ou à une feuille de calcul spécifique. Les valeurs possibles sont : Feuille de calcul, Classeur.
getType()	Spécifie le type de la valeur retournée par la formule du nom. Pour plus d’informations, consultez ExcelScript.NamedItemType .
getValue()	Représente la valeur calculée par la formule du nom. Pour une plage nommée, elle renvoie l’adresse de la plage. Cette API retourne le #VALUE ! dans l’interface utilisateur Excel si elle fait référence à une fonction définie par l’utilisateur.
getVisible()	Spécifie si l’objet est visible.
getWorksheet()	Retourne la feuille de calcul dans laquelle l’élément nommé est limité. Si l’élément est limité au classeur à la place, cette méthode retourne undefined.
setComment(comment)	Spécifie le commentaire associé à ce nom.
setFormula(formula)	Formule de l’élément nommé. Les formules commencent toujours par un signe égal (« = »).
setVisible(visible)	Spécifie si l’objet est visible.

Détails de la méthode

delete()

Supprime le nom donné.

delete(): void;

Retours

void

getArrayValues()

Renvoie un objet contenant les valeurs et les types de l’élément nommé.

getArrayValues(): NamedItemArrayValues;

Retours

ExcelScript.NamedItemArrayValues

getComment()

Spécifie le commentaire associé à ce nom.

getComment(): string;

Retours

string

getFormula()

Formule de l’élément nommé. Les formules commencent toujours par un signe égal (« = »).

getFormula(): string;

Retours

string

getName()

Nom de l’objet.

getName(): string;

Retours

string

getRange()

Renvoie l’objet de plage qui est associé au nom. Si le type de l’élément nommé n’est pas une plage, cette méthode retourne undefined.

getRange(): Range;

Retours

ExcelScript.Range

getScope()

Spécifie si le nom est limité au classeur ou à une feuille de calcul spécifique. Les valeurs possibles sont : Feuille de calcul, Classeur.

getScope(): NamedItemScope;

Retours

ExcelScript.NamedItemScope

getType()

Spécifie le type de la valeur retournée par la formule du nom. Pour plus d’informations, consultez ExcelScript.NamedItemType .

getType(): NamedItemType;

Retours

ExcelScript.NamedItemType

Exemples

/**
 * This script looks for every named range with "Review" in the name 
 * and marks the range with a yellow fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Look at every named item in the workbook.
  workbook.getNames().forEach((namedItem) => {
    // Find names containing "Review".
    if (namedItem.getName().includes("Review")) {
      // Only change the fill color if the named item is a range (not a formula).
      let itemType: ExcelScript.NamedItemType = namedItem.getType();
      if (itemType === ExcelScript.NamedItemType.range) {
        // Set the range's fill color to yellow.
        namedItem.getRange().getFormat().getFill().setColor("yellow");
      }
    }
  });
}

getValue()

Représente la valeur calculée par la formule du nom. Pour une plage nommée, elle renvoie l’adresse de la plage. Cette API retourne le #VALUE ! dans l’interface utilisateur Excel si elle fait référence à une fonction définie par l’utilisateur.

getValue(): string | number;

Retours

string | number

getVisible()

Spécifie si l’objet est visible.

getVisible(): boolean;

Retours

boolean

getWorksheet()

Retourne la feuille de calcul dans laquelle l’élément nommé est limité. Si l’élément est limité au classeur à la place, cette méthode retourne undefined.

getWorksheet(): Worksheet | undefined;

Retours

ExcelScript.Worksheet | undefined

setComment(comment)

Spécifie le commentaire associé à ce nom.

setComment(comment: string): void;

Paramètres

comment

string

Retours

void

setFormula(formula)

Formule de l’élément nommé. Les formules commencent toujours par un signe égal (« = »).

setFormula(formula: string): void;

Paramètres

formula

string

Retours

void

setVisible(visible)

Spécifie si l’objet est visible.

setVisible(visible: boolean): void;

Paramètres

visible

boolean

Retours

void