Excel.WorksheetCollection 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.Worksheet[];

Valor de propiedad

Agrega una nueva hoja al libro. La hoja de cálculo se agregará al final de las hojas de cálculo existentes. Si desea activar la hoja de cálculo recién agregada, llame a .activate() ella.

add(name?: string): Excel.Worksheet;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const wSheetName = 'Sample Name';
    const worksheet = context.workbook.worksheets.add(wSheetName);
    worksheet.load('name');
    await context.sync();
    
    console.log(worksheet.name);
});

Obtiene la hoja de cálculo activa del libro.

getActiveWorksheet(): Excel.Worksheet;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => {  
    const activeWorksheet = context.workbook.worksheets.getActiveWorksheet();
    activeWorksheet.load('name');
    await context.sync();
    console.log(activeWorksheet.name);
});

Obtiene el número de hojas de cálculo de la colección.

getCount(visibleOnly?: boolean): OfficeExtension.ClientResult<number>;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Obtiene la primera hoja de cálculo de la colección.

getFirst(visibleOnly?: boolean): Excel.Worksheet;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.5 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;

    // We don't want to include the default worksheet that was created
    // when the workbook was created, so our "firstSheet" will be the one
    // after the literal first. Note chaining of navigation methods.
    const firstSheet = sheets.getFirst().getNext();
    const lastSheet = sheets.getLast();
    const firstTaxRateRange = firstSheet.getRange("B2");
    const lastTaxRateRange = lastSheet.getRange("B2");

    firstSheet.load("name");
    lastSheet.load("name");
    firstTaxRateRange.load("text");
    lastTaxRateRange.load("text");

    await context.sync();

    let firstYear = firstSheet.name.substr(5, 4);
    let lastYear = lastSheet.name.substr(5, 4);
    console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`)

    await context.sync();
});

Obtiene un objeto de hoja de cálculo mediante su nombre o identificador.

getItem(key: string): Excel.Worksheet;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Obtiene un objeto de hoja de cálculo mediante su nombre o identificador. Si la hoja de cálculo 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(key: string): Excel.Worksheet;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Obtiene la última hoja de cálculo de la colección.

getLast(visibleOnly?: boolean): Excel.Worksheet;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.5 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;

    // We don't want to include the default worksheet that was created
    // when the workbook was created, so our "firstSheet" will be the one
    // after the literal first. Note chaining of navigation methods.
    const firstSheet = sheets.getFirst().getNext();
    const lastSheet = sheets.getLast();
    const firstTaxRateRange = firstSheet.getRange("B2");
    const lastTaxRateRange = lastSheet.getRange("B2");

    firstSheet.load("name");
    lastSheet.load("name");
    firstTaxRateRange.load("text");
    lastTaxRateRange.load("text");

    await context.sync();

    let firstYear = firstSheet.name.substr(5, 4);
    let lastYear = lastSheet.name.substr(5, 4);
    console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`)

    await context.sync();
});

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.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection;

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.WorksheetCollection;

Parámetros

Devoluciones

Ejemplos

await Excel.run(async (context) => { 
    const worksheets = context.workbook.worksheets;
    worksheets.load('items');
    await context.sync();
    
    for (let i = 0; i < worksheets.items.length; i++) {
        console.log(worksheets.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.WorksheetCollection;

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.WorksheetCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WorksheetCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Excel.Interfaces.WorksheetCollectionData;

Devoluciones

Se produce cuando se activa cualquier hoja de cálculo del libro.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml

await Excel.run(async (context) => {
    let sheets = context.workbook.worksheets;
    sheets.onActivated.add(onActivate);

    await context.sync();
    console.log("A handler has been registered for the OnActivate event.");
});

Se produce cuando se agrega una nueva hoja de cálculo al libro.

readonly onAdded: OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets;
    sheet.onAdded.add(onWorksheetAdd);

    await context.sync();
    console.log("A handler has been registered for the OnAdded event.");
});

Se produce cuando se calcula cualquier hoja de cálculo del libro.

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Se produce cuando se cambia una hoja de cálculo del libro.

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Se produce cuando se han ordenado una o más columnas. Esto sucede cuando se produce una operación de ordenación de izquierda a derecha.

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

Se produce cuando se desactiva cualquier hoja de cálculo del libro.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml

await Excel.run(async (context) => {
    let sheets = context.workbook.worksheets;
    sheets.onDeactivated.add(onDeactivate);

    await context.sync();
    console.log("A handler has been registered for the OnDeactivate event.");
});

Se produce cuando se elimina una hoja de cálculo del libro.

readonly onDeleted: OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Se produce cuando cualquier hoja de cálculo del libro tiene un formato cambiado.

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Se produce cuando se cambian una o varias fórmulas en cualquier hoja de cálculo de esta colección. Este evento es para cuando cambia la propia fórmula, no para el valor de datos resultante del cálculo de la fórmula.

readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.13 ]

Se produce cuando se cambia el estado de protección de la hoja de cálculo.

readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Se produce cuando el estado oculto de una o varias filas ha cambiado en una hoja de cálculo específica.

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.11 ]

Se produce cuando se han ordenado una o más filas. Esto sucede cuando se produce una operación de ordenación de arriba a abajo.

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

Se produce cuando cambia la selección de cualquier hoja de cálculo.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Se produce cuando se produce la operación de pulsar o hacer clic con el botón izquierdo en la colección de hojas de cálculo. Este evento no se desencadenará al hacer clic en los casos siguientes: - El usuario arrastra el mouse para realizar una selección múltiple. - El usuario selecciona una celda en el modo cuando se seleccionan argumentos de celda para las referencias de fórmula.

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

Tipo de evento

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]