Excel.NamedItemCollection class

  • Referência
Pacote:
excel

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
OfficeExtension.ClientObject

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

getItem(name)

Obtém um NamedItem objeto com o respetivo nome.
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(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
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.

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

Excel.RequestContext

items

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.NamedItem[];

Valor da propriedade

Excel.NamedItem[]

Detalhes do método

getItem(name)

Obtém um NamedItem objeto com o respetivo nome.

getItem(name: string): Excel.NamedItem;

Parâmetros

name

string

Nome nameitem.

Retornos

Excel.NamedItem

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);
});

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

options

Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.NamedItemCollection

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

Excel.NamedItemCollection

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

Excel.NamedItemCollection

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;

Retornos

Excel.Interfaces.NamedItemCollectionData