Excel.NamedItem class
Representa um nome definido para um intervalo de células ou um valor. Os nomes podem ser objetos chamados primitivos (como visto no tipo abaixo), objeto range ou uma referência a um intervalo. Use esse objeto para obter um objeto de intervalo associado aos nomes.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml
await Excel.run(async (context) => {
// Log all the named items in the active worksheet.
const namedItems = context.workbook.worksheets.getActiveWorksheet().names.load();
await context.sync();
console.log("This worksheet contains " + namedItems.items.length + " named items.");
for (let i = 0; i < namedItems.items.length; i++) {
const namedItem : Excel.NamedItem = namedItems.items[i];
console.log(JSON.stringify(namedItem)) + "\n";
}
await context.sync();
});
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 igual ("="). |
| name | O nome do objeto. |
| scope | 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 | Especifica o tipo do valor retornado pela fórmula do nome. Confira |
| value | 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 |
Uma representação JSON dos valores neste item nomeado. Ao contrário |
| value |
Uma representação JSON dos valores neste item nomeado. Ao contrário |
| visible | Especifica se o objeto está visível. |
| worksheet | Retorna a planilha em que o item nomeado tem escopo. Gerará um erro se o item estiver no escopo da pasta de trabalho. |
| worksheet |
Retorna a planilha à qual o item nomeado está no escopo. Se o item estiver no escopo da 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
comment
Especifica o comentário associado a esse nome.
comment: string;Valor da propriedade
string
Comentários
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 igual ("=").
formula: any;Valor da propriedade
any
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/update-named-item.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
// Get the named item
const myNamedItem = sheet.names.getItemOrNullObject("MyRange");
myNamedItem.load("name, formula");
await context.sync();
if (myNamedItem.isNullObject) {
console.log(`There is no named item. Create it with "Add named item for a range" first.`);
} else {
// Update named item to point to the second range
myNamedItem.formula = "=Sample!$B$10:$D$14";
sheet.getRange("B10:D14").select();
await context.sync();
console.log(`Just updated the named item "${myNamedItem.name}" -- it's now located here: ${myNamedItem.formula}`);
}
});
name
O nome do objeto.
readonly name: string;Valor da propriedade
string
Comentários
scope
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.
readonly scope: Excel.NamedItemScope | "Worksheet" | "Workbook";Valor da propriedade
Excel.NamedItemScope | "Worksheet" | "Workbook"
Comentários
type
Especifica o tipo do valor retornado pela fórmula do nome. Confira Excel.NamedItemType 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 API: ExcelApi 1.1 para String,Integer,Double,Boolean,Range,Error; 1.7 para Matriz ]
value
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.
readonly value: any;Valor da propriedade
any
Comentários
valueAsJson
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.
readonly valueAsJson: CellValue | string;Valor da propriedade
Excel.CellValue | string
Comentários
valueAsJsonLocal
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.
readonly valueAsJsonLocal: CellValue | string;Valor da propriedade
Excel.CellValue | string
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. Gerará um erro se o item estiver no escopo da pasta de trabalho.
readonly worksheet: Excel.Worksheet;Valor da propriedade
Comentários
worksheetOrNullObject
Retorna a planilha à qual o item nomeado está no 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.
readonly worksheetOrNullObject: Excel.Worksheet;Valor da propriedade
Comentários
Detalhes do método
delete()
Exclui o nome fornecido.
delete(): void;Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const totalName = sheet.names.getItemOrNullObject("TotalAmount");
totalName.load();
await context.sync();
if (totalName.value) {
totalName.delete();
// Replace the named item (TotalAmount) with the actual formula for TotalAmount to avoid displaying #NAME in the cell.
sheet.getRange("D11").values = [["=SUM(ExpensesTable[AMOUNT])"]];
} else {
console.log("No named item created for the formula.");
}
await context.sync();
});
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 API: ExcelApi 1.1 ]
Exemplos
// Returns the Range object that is associated with the name.
// Returns `null` if the name is not of type Range.
// Note: This API currently supports only the Workbook scoped items.
await Excel.run(async (context) => {
const names = context.workbook.names;
const range = names.getItem('MyRange').getRange();
range.load('address');
await context.sync();
console.log(range.address);
});
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
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 carregar.
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írgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
Exemplos
await Excel.run(async (context) => {
const names = context.workbook.names;
const namedItem = names.getItem('MyRange');
namedItem.load('type');
await context.sync();
console.log(namedItem.type);
});
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írgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas 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 properties tentar definir quaisquer 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.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.NamedItem original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NamedItemData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.NamedItemData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de