Compartir a través de

ExcelScript.NamedItem interface

  • Referencia
Paquete:
ExcelScript

Representa un nombre definido para un rango de celdas o un valor. Los nombres pueden ser objetos con nombre primitivos (como se muestra en el tipo siguiente), objeto de rango o una referencia a un rango. Este objeto puede usarse para obtener un objeto de rango asociado a nombres.

Comentarios

Ejemplos

/**
 * 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étodos

delete()

Elimina el nombre especificado.
getArrayValues()

Devuelve un objeto que contiene los valores y tipos del elemento con nombre.
getComment()

Especifica el comentario asociado a este nombre.
getFormula()

Fórmula del elemento con nombre. Las fórmulas siempre comienzan con un signo igual ("=").
getName()

Nombre del objeto.
getRange()

Devuelve el objeto de rango asociado al nombre. Si el tipo del elemento con nombre no es un intervalo, este método devuelve undefined.
getScope()

Especifica si el nombre se limita al libro o a una hoja de cálculo específica. Los valores posibles son: Worksheet, Workbook.
getType()

Especifica el tipo del valor devuelto por la fórmula del nombre. Vea ExcelScript.NamedItemType para más información.
getValue()

Representa el valor calculado por la fórmula del nombre. Para un intervalo con nombre, devolverá la dirección del intervalo. Esta API devuelve el #VALUE! error en la interfaz de usuario de Excel si hace referencia a una función definida por el usuario.
getVisible()

Especifica si el objeto está visible.
getWorksheet()

Devuelve la hoja de cálculo a la que se limita el elemento con nombre. Si el elemento se limita al libro en su lugar, este método devuelve undefined.
setComment(comment)

Especifica el comentario asociado a este nombre.
setFormula(formula)

Fórmula del elemento con nombre. Las fórmulas siempre comienzan con un signo igual ("=").
setVisible(visible)

Especifica si el objeto está visible.

Detalles del método

delete()

Elimina el nombre especificado.

delete(): void;

Devoluciones

void

getArrayValues()

Devuelve un objeto que contiene los valores y tipos del elemento con nombre.

getArrayValues(): NamedItemArrayValues;

Devoluciones

ExcelScript.NamedItemArrayValues

getComment()

Especifica el comentario asociado a este nombre.

getComment(): string;

Devoluciones

string

getFormula()

Fórmula del elemento con nombre. Las fórmulas siempre comienzan con un signo igual ("=").

getFormula(): string;

Devoluciones

string

getName()

Nombre del objeto.

getName(): string;

Devoluciones

string

getRange()

Devuelve el objeto de rango asociado al nombre. Si el tipo del elemento con nombre no es un intervalo, este método devuelve undefined.

getRange(): Range;

Devoluciones

ExcelScript.Range

getScope()

Especifica si el nombre se limita al libro o a una hoja de cálculo específica. Los valores posibles son: Worksheet, Workbook.

getScope(): NamedItemScope;

Devoluciones

ExcelScript.NamedItemScope

getType()

Especifica el tipo del valor devuelto por la fórmula del nombre. Vea ExcelScript.NamedItemType para más información.

getType(): NamedItemType;

Devoluciones

ExcelScript.NamedItemType

Ejemplos

/**
 * 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()

Representa el valor calculado por la fórmula del nombre. Para un intervalo con nombre, devolverá la dirección del intervalo. Esta API devuelve el #VALUE! error en la interfaz de usuario de Excel si hace referencia a una función definida por el usuario.

getValue(): string | number;

Devoluciones

string | number

getVisible()

Especifica si el objeto está visible.

getVisible(): boolean;

Devoluciones

boolean

getWorksheet()

Devuelve la hoja de cálculo a la que se limita el elemento con nombre. Si el elemento se limita al libro en su lugar, este método devuelve undefined.

getWorksheet(): Worksheet | undefined;

Devoluciones

ExcelScript.Worksheet | undefined

setComment(comment)

Especifica el comentario asociado a este nombre.

setComment(comment: string): void;

Parámetros

comment

string

Devoluciones

void

setFormula(formula)

Fórmula del elemento con nombre. Las fórmulas siempre comienzan con un signo igual ("=").

setFormula(formula: string): void;

Parámetros

formula

string

Devoluciones

void

setVisible(visible)

Especifica si el objeto está visible.

setVisible(visible: boolean): void;

Parámetros

visible

boolean

Devoluciones

void