Excel.NamedItemCollection class
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.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(name, reference, comment) | Adiciona um novo nome à coleção do escopo fornecido. |
| add |
Adiciona um novo nome à coleção de escopo fornecido usando a localidade do usuário para a fórmula. |
| get |
Obtém o número de itens nomeados na coleção. |
| get |
Obtém um |
| get |
Obtém um |
| 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 |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.NamedItem[];Valor da propriedade
Detalhes do método
add(name, reference, comment)
Adiciona um novo nome à coleção do escopo fornecido.
add(name: string, reference: Range | string, comment?: string): Excel.NamedItem;Parâmetros
- name
-
string
O nome do item nomeado.
- reference
-
Excel.Range | string
A fórmula ou o intervalo ao qual o nome fará referência.
- comment
-
string
Opcional. O comentário associado ao item com nome.
Retornos
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 headerRange = sheet.getRange("A1:D1");
sheet.names.add("ExpensesHeader", headerRange);
const namedItems = sheet.names.load("name, type");
await context.sync();
});
addFormulaLocal(name, formula, comment)
Adiciona um novo nome à coleção de escopo fornecido usando a localidade do usuário para a fórmula.
addFormulaLocal(name: string, formula: string, comment?: string): Excel.NamedItem;Parâmetros
- name
-
string
O nome do item nomeado.
- formula
-
string
A fórmula na localidade do usuário à qual o nome se referirá.
- comment
-
string
Opcional. O comentário associado ao item com nome.
Retornos
Comentários
getCount()
Obtém o número de itens nomeados na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(name)
Obtém um NamedItem objeto com o respetivo nome.
getItem(name: string): Excel.NamedItem;Parâmetros
- name
-
string
Nome nameitem.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
await Excel.run(async (context) => {
const sheetName = 'Sheet1';
const nameditem = context.workbook.names.getItem(sheetName);
nameditem.load('type');
await context.sync();
console.log(nameditem.type);
});
getItemOrNullObject(name)
Obtém um NamedItem objeto com o respetivo nome. Se o objeto não existir, 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).
getItemOrNullObject(name: string): Excel.NamedItem;Parâmetros
- name
-
string
Nome nameitem.
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.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection;Parâmetros
Fornece opções para as propriedades do objeto a 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.NamedItemCollection;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
Exemplos
await Excel.run(async (context) => {
const nameditems = context.workbook.names;
nameditems.load('items');
await context.sync();
for (let i = 0; i < nameditems.items.length; i++) {
console.log(nameditems.items[i].name);
}
});
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?: OfficeExtension.LoadOption): Excel.NamedItemCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.NamedItemCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.NamedItemCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.NamedItemCollectionData;