ExcelScript.NamedItem interface

Pacote:

ExcelScript

Representa um nome definido para um intervalo de células ou um valor. Os nomes podem ser objetos com nomes primitivos (como se pode ver 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

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 este nome.
getFormula()	A fórmula do item com nome. As fórmulas começam sempre 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, este método devolve undefined.
getScope()	Especifica se o nome está no âmbito do livro ou de uma folha de cálculo específica. Os valores possíveis são: Folha de Cálculo, Livro.
getType()	Especifica o tipo do valor devolvido pela fórmula do nome. Veja ExcelScript.NamedItemType para obter detalhes.
getValue()	Representa o valor calculado pela fórmula do nome. Para um intervalo com nome, irá devolver o endereço do intervalo. Esta API devolve o #VALUE! na IU do Excel, se se referir a uma função definida pelo utilizador.
getVisible()	Especifica se o objeto está visível.
getWorksheet()	Devolve a folha de cálculo na qual o item com nome está no âmbito. Se, em vez disso, o item estiver no âmbito do livro, este método devolve undefined.
setComment(comment)	Especifica o comentário associado a este nome.
setFormula(formula)	A fórmula do item com nome. As fórmulas começam sempre com um sinal de igual ("=").
setVisible(visible)	Especifica se o objeto está 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 este nome.

getComment(): string;

Retornos

string

getFormula()

A fórmula do item com nome. As fórmulas começam sempre 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, este método devolve undefined.

getRange(): Range;

Retornos

ExcelScript.Range

getScope()

Especifica se o nome está no âmbito do livro ou de uma folha de cálculo específica. Os valores possíveis são: Folha de Cálculo, Livro.

getScope(): NamedItemScope;

Retornos

ExcelScript.NamedItemScope

getType()

Especifica o tipo do valor devolvido pela fórmula do nome. Veja 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 com nome, irá devolver o endereço do intervalo. Esta API devolve o #VALUE! na IU do Excel, se se referir a uma função definida pelo utilizador.

getValue(): string | number;

Retornos

string | number

getVisible()

Especifica se o objeto está visível.

getVisible(): boolean;

Retornos

boolean

getWorksheet()

Devolve a folha de cálculo na qual o item com nome está no âmbito. Se, em vez disso, o item estiver no âmbito do livro, este método devolve undefined.

getWorksheet(): Worksheet | undefined;

Retornos

ExcelScript.Worksheet | undefined

setComment(comment)

Especifica o comentário associado a este nome.

setComment(comment: string): void;

Parâmetros

comment

string

Retornos

void

setFormula(formula)

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

setFormula(formula: string): void;

Parâmetros

formula

string

Retornos

void

setVisible(visible)

Especifica se o objeto está visível.

setVisible(visible: boolean): void;

Parâmetros

visible

boolean

Retornos

void