Excel.Interfaces.NamedItemLoadOptions interface
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
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| $all | Especificar |
| array |
Retorna um objeto que contém valores e tipos do item nomeado. |
| comment | Especifica o comentário associado a este nome. |
| formula | A fórmula do item com nome. As fórmulas começam sempre com um sinal de igual ("="). |
| name | O nome do objeto. |
| scope | 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 | Especifica o tipo do valor devolvido pela fórmula do nome. Veja |
| value | 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 |
Uma representação JSON dos valores neste item com nome. Ao contrário |
| value |
Uma representação JSON dos valores neste item com nome. Ao contrário |
| visible | Especifica se o objeto está visível. |
| worksheet | Retorna a planilha em que o item nomeado tem escopo. Gera um erro se o item estiver no âmbito do livro. |
| worksheet |
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 um objeto com a respetiva |
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
Retorna um objeto que contém valores e tipos do item nomeado.
arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;Valor da propriedade
Comentários
comment
Especifica o comentário associado a este nome.
comment?: boolean;Valor da propriedade
boolean
Comentários
formula
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
name
O nome do objeto.
name?: boolean;Valor da propriedade
boolean
Comentários
scope
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
type
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
value
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
valueAsJson
Uma representação JSON dos valores neste item com nome. 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
valueAsJsonLocal
Uma representação JSON dos valores neste item com nome. 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
visible
Especifica se o objeto está visível.
visible?: boolean;Valor da propriedade
boolean
Comentários
worksheet
Retorna a planilha em que o item nomeado tem escopo. Gera um erro se o item estiver no âmbito do livro.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;Valor da propriedade
Comentários
worksheetOrNullObject
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 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;