Excel.Interfaces.NamedItemLoadOptions interface
Representa um nome definido para um intervalo de células ou um valor. Os nomes podem ser objetos nomeados primitivos (como visto 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 apis: 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 esse nome. |
| formula | A fórmula do item nomeado. As fórmulas sempre começam com um sinal de igual ("="). |
| name | O nome do objeto. |
| scope | Especifica se o escopo do nome está na pasta de trabalho ou em 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. Consulte |
| value | Representa o valor calculado pela fórmula do nome. Para um intervalo nomeado, ele retornará o endereço do intervalo. Essa API retorna o #VALUE! na interface do usuário do Excel se ele se referir a uma função definida pelo usuário. |
| value |
Uma representação JSON dos valores neste item nomeado. Ao contrário do |
| value |
Uma representação JSON dos valores neste item nomeado. Ao contrário do |
| visible | Especifica se o objeto é visível. |
| worksheet | Retorna a planilha em que o item nomeado tem escopo. Gera um erro se o item tiver como escopo a pasta de trabalho. |
| worksheet |
Retorna a planilha que tem como escopo o item nomeado. Se o item tiver como escopo a pasta de trabalho, esse método retornará um objeto com sua |
Detalhes da propriedade
$all
Especificar $all as opções de carga carrega todas as propriedades escalares (comoRange.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
[Conjunto de apis: ExcelApi 1.7]
comment
Especifica o comentário associado a esse nome.
comment?: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.4]
formula
A fórmula do item nomeado. As fórmulas sempre começam com um sinal de igual ("=").
formula?: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
name
O nome do objeto.
name?: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.1]
scope
Especifica se o escopo do nome está na pasta de trabalho ou em uma planilha específica. Os valores possíveis são: Planilha, Pasta de trabalho.
scope?: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.4]
type
Especifica o tipo do valor retornado pela fórmula do nome. Consulte Excel.NamedItemType para obter detalhes.
type?: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.1 para String,Integer,Double,Boolean,Range,Error; 1.7 para Array]
value
Representa o valor calculado pela fórmula do nome. Para um intervalo nomeado, ele retornará o endereço do intervalo. Essa API retorna o #VALUE! na interface do usuário do Excel se ele se referir a uma função definida pelo usuário.
value?: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.1]
valueAsJson
Uma representação JSON dos valores neste item nomeado. Ao contrário do NamedItem.value, NamedItem.valueAsJson oferece suporte a todos os tipos de dados que podem estar em uma célula. Os exemplos incluem valores numéricos formatados e imagens da Web, além dos valores booleanos padrão, numéricos e de 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 apis: ExcelApi 1.16]
valueAsJsonLocal
Uma representação JSON dos valores neste item nomeado. Ao contrário do NamedItem.value, NamedItem.valueAsJsonLocal oferece suporte a todos os tipos de dados que podem estar em uma célula. Os exemplos incluem valores numéricos formatados e imagens da Web, além dos valores booleanos padrão, numéricos e de cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a 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 apis: ExcelApi 1.16]
visible
Especifica se o objeto é visível.
visible?: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.1]
worksheet
Retorna a planilha em que o item nomeado tem escopo. Gera um erro se o item tiver como escopo a pasta de trabalho.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.4]
worksheetOrNullObject
Retorna a planilha que tem como escopo o item nomeado. Se o item tiver como escopo a 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 apis: ExcelApi 1.4]