Excel.NamedItem class
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.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.1]
Propriedades
| array |
Retorna um objeto que contém valores e tipos do item nomeado. |
| comment | Especifica o comentário associado a esse nome. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| 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 |
Métodos
| delete() | Exclui o nome fornecido. |
| get |
Retorna o objeto Range associado ao nome. Gerará um erro se o tipo do item nomeado não for um intervalo. |
| get |
Retorna o objeto Range associado ao nome. Se o tipo do item nomeado não for um intervalo, esse método retornará um objeto com sua |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
arrayValues
Retorna um objeto que contém valores e tipos do item nomeado.
readonly arrayValues: Excel.NamedItemArrayValues;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.7]
comment
Especifica o comentário associado a esse nome.
comment: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.4]
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
formula
A fórmula do item nomeado. As fórmulas sempre começam com um sinal de igual ("=").
formula: any;Valor da propriedade
any
Comentários
[Conjunto de apis: ExcelApi 1.7]
name
O nome do objeto.
readonly name: string;Valor da propriedade
string
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.
readonly scope: Excel.NamedItemScope | "Worksheet" | "Workbook";Valor da propriedade
Excel.NamedItemScope | "Worksheet" | "Workbook"
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.
readonly 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 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.
readonly value: any;Valor da propriedade
any
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.
readonly valueAsJson: CellValue | string;Valor da propriedade
Excel.CellValue | string
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.
readonly valueAsJsonLocal: CellValue | string;Valor da propriedade
Excel.CellValue | string
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.
readonly worksheet: Excel.Worksheet;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.
readonly worksheetOrNullObject: Excel.Worksheet;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.4]
Detalhes do método
delete()
Exclui o nome fornecido.
delete(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.4]
getRange()
Retorna o objeto Range associado ao nome. Gerará um erro se o tipo do item nomeado não for um intervalo.
getRange(): Excel.Range;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.1]
getRangeOrNullObject()
Retorna o objeto Range associado ao nome. Se o tipo do item nomeado não for um intervalo, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getRangeOrNullObject(): Excel.Range;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.4]
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Excel.Interfaces.NamedItemLoadOptions): Excel.NamedItem;Parâmetros
Fornece opções para quais propriedades do objeto devem ser carregadas.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.NamedItem;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.NamedItem;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.NamedItemUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.NamedItemUpdateData
Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
set(properties: Excel.NamedItem): void;Parâmetros
- properties
- Excel.NamedItem
Retornos
void
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.NamedItem é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NamedItemData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.NamedItemData;