Excel.NamedItemCollection class

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.NamedItem[];

Valor de propiedad

Obtiene un NamedItem objeto usando su nombre.

getItem(name: string): Excel.NamedItem;

Parámetros

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.1

Ejemplos

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

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.NamedItemCollection;

Parámetros

Devoluciones

Ejemplos

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

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NamedItemCollection;

Parámetros

Devoluciones

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.NamedItemCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.NamedItemCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.

toJSON(): Excel.Interfaces.NamedItemCollectionData;

Devoluciones