ExcelScript.NamedItem interface

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

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. A fórmula sempre começa com um sinal de "=".

getName()

O nome do objeto.

getRange()

Retorna o objeto Range associado ao nome. Retornará um objeto null se o tipo do item nomeado não for um intervalo.

getScope()

Especifica se o nome tem como escopo a pasta de trabalho ou 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, retornará o endereço do intervalo.

getVisible()

Especifica se o objeto está visível.

getWorksheet()

Retorna a planilha em que o item nomeado tem escopo. Retornará um objeto null se o item tiver escopo para a pasta de trabalho em vez disso.

setComment(comment)

Especifica o comentário associado a esse nome.

setFormula(formula)

A fórmula do item nomeado. A fórmula sempre começa com um sinal de "=".

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

getComment()

Especifica o comentário associado a esse nome.

getComment(): string;

Retornos

string

getFormula()

A fórmula do item nomeado. A fórmula sempre começa com um sinal de "=".

getFormula(): string;

Retornos

string

getName()

O nome do objeto.

getName(): string;

Retornos

string

getRange()

Retorna o objeto Range associado ao nome. Retornará um objeto null se o tipo do item nomeado não for um intervalo.

getRange(): Range;

Retornos

getScope()

Especifica se o nome tem como escopo a pasta de trabalho ou uma planilha específica. Os valores possíveis são: planilha, pasta de trabalho.

getScope(): NamedItemScope;

Retornos

getType()

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

getType(): NamedItemType;

Retornos

getValue()

Representa o valor calculado pela fórmula do nome. Para um intervalo nomeado, retornará o endereço do intervalo.

getValue(): string | number;

Retornos

string | number

getVisible()

Especifica se o objeto está visível.

getVisible(): boolean;

Retornos

boolean

getWorksheet()

Retorna a planilha em que o item nomeado tem escopo. Retornará um objeto null se o item tiver escopo para a pasta de trabalho em vez disso.

getWorksheet(): Worksheet | undefined;

Retornos

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. A fórmula sempre começa com um sinal de "=".

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