ExcelScript.NamedItem interface

Pacote:
ExcelScript

Representa um nome definido para um intervalo de células ou um valor. Os nomes podem ser objetos nomeados primitivos (como visto no tipo abaixo), objeto de intervalo ou uma referência a um intervalo. Use esse objeto para obter um objeto de intervalo associado aos nomes.

Comentários

Usada por

Exemplos

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

Exclui o nome fornecido.
getArrayValues()

Retorna um objeto que contém valores e tipos do item nomeado.
getComment()

Especifica o comentário associado a esse nome.
getFormula()

A fórmula do item nomeado. As fórmulas sempre começam com um sinal de igual ("=").
getName()

O nome do objeto.
getRange()

Retorna o objeto Range associado ao nome. Se o tipo do item nomeado não for um intervalo, esse método retornará undefined.
getScope()

Especifica se o escopo do nome está na pasta de trabalho ou em uma planilha específica. Os valores possíveis são: Planilha, Pasta de trabalho.
getType()

Especifica o tipo do valor retornado pela fórmula do nome. Consulte ExcelScript.NamedItemType para obter detalhes.
getValue()

Representa o valor calculado pela fórmula do nome. Para um intervalo nomeado, ele retornará o endereço do intervalo. Essa API retorna o #VALUE! na interface do usuário do Excel se ele se referir a uma função definida pelo usuário.
getVisible()

Especifica se o objeto é visível.
getWorksheet()

Retorna a planilha que tem como escopo o item nomeado. Se o item tiver como escopo a pasta de trabalho, esse método retornará undefined.
setComment(comment)

Especifica o comentário associado a esse nome.
setFormula(formula)

A fórmula do item nomeado. As fórmulas sempre começam com um sinal de igual ("=").
setVisible(visible)

Especifica se o objeto é visível.

Detalhes do método

delete()

Exclui o nome fornecido.

delete(): void;

Retornos

void

getArrayValues()

Retorna um objeto que contém valores e tipos do item nomeado.

getArrayValues(): NamedItemArrayValues;

Retornos

ExcelScript.NamedItemArrayValues

getComment()

Especifica o comentário associado a esse nome.

getComment(): string;

Retornos

string

getFormula()

A fórmula do item nomeado. As fórmulas sempre começam com um sinal de igual ("=").

getFormula(): string;

Retornos

string

getName()

O nome do objeto.

getName(): string;

Retornos

string

getRange()

Retorna o objeto Range associado ao nome. Se o tipo do item nomeado não for um intervalo, esse método retornará undefined.

getRange(): Range;

Retornos

ExcelScript.Range

getScope()

Especifica se o escopo do nome está na pasta de trabalho ou em uma planilha específica. Os valores possíveis são: Planilha, Pasta de trabalho.

getScope(): NamedItemScope;

Retornos

ExcelScript.NamedItemScope

getType()

Especifica o tipo do valor retornado pela fórmula do nome. Consulte ExcelScript.NamedItemType para obter detalhes.

getType(): NamedItemType;

Retornos

ExcelScript.NamedItemType

Exemplos

/**
 * 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 o valor calculado pela fórmula do nome. Para um intervalo nomeado, ele retornará o endereço do intervalo. Essa API retorna o #VALUE! na interface do usuário do Excel se ele se referir a uma função definida pelo usuário.

getValue(): string | number;

Retornos

string | number

getVisible()

Especifica se o objeto é visível.

getVisible(): boolean;

Retornos

boolean

getWorksheet()

Retorna a planilha que tem como escopo o item nomeado. Se o item tiver como escopo a pasta de trabalho, esse método retornará undefined.

getWorksheet(): Worksheet | undefined;

Retornos

ExcelScript.Worksheet | undefined

setComment(comment)

Especifica o comentário associado a esse nome.

setComment(comment: string): void;

Parâmetros

comment

string

Retornos

void

setFormula(formula)

A fórmula do item nomeado. As fórmulas sempre começam com um sinal de igual ("=").

setFormula(formula: string): void;

Parâmetros

formula

string

Retornos

void

setVisible(visible)

Especifica se o objeto é visível.

setVisible(visible: boolean): void;

Parâmetros

visible

boolean

Retornos

void