Share via


Excel.Interfaces.NamedItemData interface

Uma interface que descreve os dados retornados chamando namedItem.toJSON().

Propriedades

arrayValues

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

comment

Especifica o comentário associado a esse nome.

formula

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

name

O nome do objeto.

scope

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

type

Especifica o tipo do valor retornado pela fórmula do nome. Confira Excel.NamedItemType detalhes.

value

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

valueAsJson

Uma representação JSON dos valores neste item nomeado. Ao contrário NamedItem.valuede , NamedItem.valueAsJson dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade en-US. Para recuperar dados na localidade de exibição do usuário, use NamedItem.valueAsJsonLocal.

valueAsJsonLocal

Uma representação JSON dos valores neste item nomeado. Ao contrário NamedItem.valuede , NamedItem.valueAsJsonLocal dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham à localidade de exibição do usuário. Para recuperar dados independentes da localidade, use NamedItem.valueAsJson.

visible

Especifica se o objeto está visível.

Detalhes da propriedade

arrayValues

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

arrayValues?: Excel.Interfaces.NamedItemArrayValuesData;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

comment

Especifica o comentário associado a esse nome.

comment?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

formula

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

formula?: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

name

O nome do objeto.

name?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

scope

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

scope?: Excel.NamedItemScope | "Worksheet" | "Workbook";

Valor da propriedade

Excel.NamedItemScope | "Worksheet" | "Workbook"

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

type

Especifica o tipo do valor retornado pela fórmula do nome. Confira Excel.NamedItemType detalhes.

type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";

Valor da propriedade

Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"

Comentários

[ Conjunto de API: ExcelApi 1.1 para String,Integer,Double,Boolean,Range,Error; 1.7 para Matriz ]

value

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

value?: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

valueAsJson

Uma representação JSON dos valores neste item nomeado. Ao contrário NamedItem.valuede , NamedItem.valueAsJson dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade en-US. Para recuperar dados na localidade de exibição do usuário, use NamedItem.valueAsJsonLocal.

valueAsJson?: CellValue | string;

Valor da propriedade

Excel.CellValue | string

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

valueAsJsonLocal

Uma representação JSON dos valores neste item nomeado. Ao contrário NamedItem.valuede , NamedItem.valueAsJsonLocal dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham à localidade de exibição do usuário. Para recuperar dados independentes da localidade, use NamedItem.valueAsJson.

valueAsJsonLocal?: CellValue | string;

Valor da propriedade

Excel.CellValue | string

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

visible

Especifica se o objeto está visível.

visible?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]