Compartilhar via


Excel.Interfaces.NamedItemCollectionLoadOptions interface

Uma coleção de todos os NamedItem objetos que fazem parte do livro ou folha de cálculo, consoante a forma como foram alcançados.

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

$all

Especificar $all para as opções de carga carrega todas as propriedades escalares (como Range.address) mas não as propriedades de navegação (como Range.format.fill.color).

arrayValues

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

comment

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

formula

Para CADA ITEM na coleção: a fórmula do item com nome. As fórmulas começam sempre com um sinal de 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 âmbito do livro ou de uma folha de cálculo específica. Os valores possíveis são: Folha de Cálculo, Livro.

type

Para CADA ITEM na coleção: especifica o tipo do valor devolvido pela fórmula do nome. Veja Excel.NamedItemType para obter detalhes.

value

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

valueAsJson

Para CADA ITEM na coleção: uma representação JSON dos valores neste item nomeado. Ao contrário NamedItem.valuede , NamedItem.valueAsJson suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região en-US. Para obter dados na região de apresentação do utilizador, utilize 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 suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região de apresentação do utilizador. Para obter dados independentemente da região, utilize NamedItem.valueAsJson.

visible

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

worksheet

Para CADA ITEM na coleção: Devolve a folha de cálculo na qual o item com nome está no âmbito. Gera um erro se o item estiver no âmbito do livro.

worksheetOrNullObject

Para CADA ITEM na coleção: Devolve a folha de cálculo à qual o item com nome está no âmbito. Se, em vez disso, o item estiver no âmbito do livro, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

Detalhes da propriedade

$all

Especificar $all para as opções de carga carrega todas as propriedades escalares (como Range.address) mas não as propriedades de navegação (como Range.format.fill.color).

$all?: boolean;

Valor da propriedade

boolean

arrayValues

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

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 este 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 com nome. As fórmulas começam sempre com um sinal de 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 âmbito do livro ou de uma folha de cálculo específica. Os valores possíveis são: Folha de Cálculo, Livro.

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 devolvido pela fórmula do nome. Veja Excel.NamedItemType para obter detalhes.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 para Cadeia,Número Inteiro,Duplo,Booleano,Intervalo,Erro; 1,7 para Matriz ]

value

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

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 suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região en-US. Para obter dados na região de apresentação do utilizador, utilize 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 suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região de apresentação do utilizador. Para obter dados independentemente da região, utilize 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: Devolve a folha de cálculo na qual o item com nome está no âmbito. Gera um erro se o item estiver no âmbito do livro.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

worksheetOrNullObject

Para CADA ITEM na coleção: Devolve a folha de cálculo à qual o item com nome está no âmbito. Se, em vez disso, o item estiver no âmbito do livro, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.4 ]