Excel.NamedItemCollection class

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al 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

Agrega un nuevo nombre a la colección del ámbito especificado.

add(name: string, reference: Range | string, comment?: string): Excel.NamedItem;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Ejemplos

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

Agrega un nuevo nombre a la colección del ámbito especificado, empleando la configuración regional del usuario para la fórmula.

addFormulaLocal(name: string, formula: string, comment?: string): Excel.NamedItem;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Obtiene el número de elementos con nombre de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Obtiene un NamedItem objeto con 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);
});

Obtiene un NamedItem objeto con su nombre. Si el objeto no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getItemOrNullObject(name: string): Excel.NamedItem;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

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

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

toJSON(): Excel.Interfaces.NamedItemCollectionData;

Devoluciones