Share via


Excel.Interfaces.NamedItemCollectionLoadOptions interface

Uma coleção de todos os NamedItem objetos que fazem parte da pasta de trabalho ou da planilha, dependendo de como ele foi atingido.

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

$all

Especificar $all para o LoadOptions carrega todas as propriedades escalares (por exemplo: Range.address) mas não as propriedades de navegação (por exemplo: Range.format.fill.color).

arrayValues

Para CADA ITEM na coleção: retorna um objeto que contém valores e tipos do item nomeado.

comment

Para CADA ITEM na coleção: especifica o comentário associado a esse nome.

formula

Para CADA ITEM na coleção: a fórmula do item nomeado. As fórmulas sempre começam com um sinal igual ("=").

name

Para CADA ITEM na coleção: o nome do objeto.

scope

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: especifica o tipo do valor retornado pela fórmula do nome. Confira Excel.NamedItemType detalhes.

value

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: especifica se o objeto está visível.

worksheet

Para CADA ITEM na coleção: retorna a planilha à qual o item nomeado está no escopo. Gerará um erro se o item estiver no escopo da pasta de trabalho.

worksheetOrNullObject

Para CADA ITEM na coleção: retorna a planilha à qual o item nomeado é escopo. Se o item estiver no escopo da pasta de trabalho, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

Detalhes da propriedade

$all

Especificar $all para o LoadOptions carrega todas as propriedades escalares (por exemplo: Range.address) mas não as propriedades de navegação (por exemplo: Range.format.fill.color).

$all?: boolean;

Valor da propriedade

boolean

arrayValues

Para CADA ITEM na coleção: retorna um objeto que contém valores e tipos do item nomeado.

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

comment

Para CADA ITEM na coleção: especifica o comentário associado a esse nome.

comment?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

formula

Para CADA ITEM na coleção: a fórmula do item nomeado. As fórmulas sempre começam com um sinal igual ("=").

formula?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

name

Para CADA ITEM na coleção: o nome do objeto.

name?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

scope

Para CADA ITEM na coleção: 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?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

type

Para CADA ITEM na coleção: especifica o tipo do valor retornado pela fórmula do nome. Confira Excel.NamedItemType detalhes.

type?: boolean;

Valor da propriedade

boolean

Comentários

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

value

Para CADA ITEM na coleção: 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?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

valueAsJson

Para CADA ITEM na coleção: 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?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

valueAsJsonLocal

Para CADA ITEM na coleção: 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?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

visible

Para CADA ITEM na coleção: especifica se o objeto está visível.

visible?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

worksheet

Para CADA ITEM na coleção: retorna a planilha à qual o item nomeado está no escopo. Gerará um erro se o item estiver no escopo da pasta de trabalho.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

worksheetOrNullObject

Para CADA ITEM na coleção: retorna a planilha à qual o item nomeado é escopo. Se o item estiver no escopo da pasta de trabalho, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.4 ]