Excel.WorksheetCollection class

Referencia

Paquete:: excel

Representa una colección de objetos de hoja de cálculo que forman parte del libro.

Extends: OfficeExtension.ClientObject

Comentarios

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
items	Obtiene los elementos secundarios cargados en esta colección.

Métodos

add(name)	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.
getActiveWorksheet()	Obtiene la hoja de cálculo activa del libro.
getCount(visibleOnly)	Obtiene el número de hojas de cálculo de la colección.
getFirst(visibleOnly)	Obtiene la primera hoja de cálculo de la colección.
getItem(key)	Obtiene un objeto de hoja de cálculo mediante su nombre o identificador.
getItemOrNullObject(key)	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).
getLast(visibleOnly)	Obtiene la última hoja de cálculo de la colección.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
toJSON()	Invalida el método JavaScript `toJSON()` para proporcionar una salida más útil cuando se pasa un objeto de 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.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.

Eventos

onActivated	Se produce cuando se activa cualquier hoja de cálculo del libro.
onAdded	Se produce cuando se agrega una nueva hoja de cálculo al libro.
onCalculated	Se produce cuando se calcula cualquier hoja de cálculo del libro.
onChanged	Se produce cuando se cambia una hoja de cálculo del libro.
onColumnSorted	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.
onDeactivated	Se produce cuando se desactiva cualquier hoja de cálculo del libro.
onDeleted	Se produce cuando se elimina una hoja de cálculo del libro.
onFormatChanged	Se produce cuando cualquier hoja de cálculo del libro tiene un formato cambiado.
onFormulaChanged	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.
onMoved	Se produce cuando una hoja de cálculo se mueve dentro de un libro. Este evento solo se desencadena cuando una hoja de cálculo se mueve directamente dentro de un libro. Este evento no se desencadena cuando la posición de una hoja de cálculo cambia indirectamente, como cuando se inserta una nueva hoja de cálculo y hace que las hojas de cálculo existentes cambien de posición.
onNameChanged	Se produce cuando se cambia el nombre de la hoja de cálculo en la colección de hojas de cálculo.
onProtectionChanged	Se produce cuando se cambia el estado de protección de la hoja de cálculo.
onRowHiddenChanged	Se produce cuando el estado oculto de una o varias filas ha cambiado en una hoja de cálculo específica.
onRowSorted	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.
onSelectionChanged	Se produce cuando cambia la selección de cualquier hoja de cálculo.
onSingleClicked	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.
onVisibilityChanged	Se produce cuando se cambia la visibilidad de la hoja de cálculo en la colección de hojas de cálculo.

Detalles de las propiedades

context

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

Excel.RequestContext

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.Worksheet[];

Valor de propiedad

Excel.Worksheet[]

Detalles del método

add(name)

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

name: string

Opcional. Nombre de la hoja de cálculo que se va a agregar. Si se especifica, el nombre debe ser único. Si no se especifica, Excel determina el nombre de la nueva hoja de cálculo.

Devoluciones

Excel.Worksheet

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

getActiveWorksheet()

Obtiene la hoja de cálculo activa del libro.

getActiveWorksheet(): Excel.Worksheet;

Devoluciones

Excel.Worksheet

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

getCount(visibleOnly)

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

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

Parámetros

visibleOnly: boolean

Opcional. Si truees , solo tiene en cuenta las hojas de cálculo visibles, omitiendo las ocultas.

Devoluciones

OfficeExtension.ClientResult<number>

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

getFirst(visibleOnly)

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

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

Parámetros

visibleOnly: boolean

Opcional. Si truees , solo tiene en cuenta las hojas de cálculo visibles, omitiendo las ocultas.

Devoluciones

Excel.Worksheet

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

getItem(key)

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

getItem(key: string): Excel.Worksheet;

Parámetros

key: string

Nombre o identificador de la hoja de cálculo.

Devoluciones

Excel.Worksheet

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

getItemOrNullObject(key)

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

key: string

Nombre o identificador de la hoja de cálculo.

Devoluciones

Excel.Worksheet

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

getLast(visibleOnly)

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

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

Parámetros

visibleOnly: boolean

Opcional. Si truees , solo tiene en cuenta las hojas de cálculo visibles, omitiendo las ocultas.

Devoluciones

Excel.Worksheet

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

load(options)

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

options: Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.WorksheetCollection

load(propertyNames)

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

propertyNames: string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.WorksheetCollection

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.WorksheetCollection

toJSON()

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

Excel.Interfaces.WorksheetCollectionData

Detalles del evento

onActivated

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

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

onAdded

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>

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

onCalculated

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

onChanged

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

onColumnSorted

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

OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

onDeactivated

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>

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

onDeleted

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

onFormatChanged

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

onFormulaChanged

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

OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.13 ]

onMoved

Se produce cuando una hoja de cálculo se mueve dentro de un libro. Este evento solo se desencadena cuando una hoja de cálculo se mueve directamente dentro de un libro. Este evento no se desencadena cuando la posición de una hoja de cálculo cambia indirectamente, como cuando se inserta una nueva hoja de cálculo y hace que las hojas de cálculo existentes cambien de posición.

readonly onMoved: OfficeExtension.EventHandlers<Excel.WorksheetMovedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetMovedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

onNameChanged

Se produce cuando se cambia el nombre de la hoja de cálculo en la colección de hojas de cálculo.

readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

onProtectionChanged

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

OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

onRowHiddenChanged

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

OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.11 ]

onRowSorted

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

OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

onSelectionChanged

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

onSingleClicked

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

OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

onVisibilityChanged

Se produce cuando se cambia la visibilidad de la hoja de cálculo en la colección de hojas de cálculo.

readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

Compartir a través de

Excel.WorksheetCollection class

Comentarios

Propiedades

Métodos

Eventos

Detalles de las propiedades

context

Valor de propiedad

items

Valor de propiedad

Detalles del método

add(name)

Parámetros

Devoluciones

Comentarios

Ejemplos

getActiveWorksheet()

Devoluciones

Comentarios

Ejemplos

getCount(visibleOnly)

Parámetros

Devoluciones

Comentarios

getFirst(visibleOnly)

Parámetros

Devoluciones

Comentarios

Ejemplos

getItem(key)

Parámetros

Devoluciones

Comentarios

getItemOrNullObject(key)

Parámetros

Devoluciones

Comentarios

getLast(visibleOnly)

Parámetros

Devoluciones

Comentarios

Ejemplos

load(options)

Parámetros

Devoluciones

load(propertyNames)

Parámetros

Devoluciones

Ejemplos

load(propertyNamesAndPaths)

Parámetros

Devoluciones

toJSON()

Devoluciones

Detalles del evento

onActivated

Tipo de evento

Comentarios

Ejemplos

onAdded

Tipo de evento

Comentarios

Ejemplos

onCalculated

Tipo de evento

Comentarios

onChanged

Tipo de evento

Comentarios

onColumnSorted

Tipo de evento

Comentarios

onDeactivated

Tipo de evento

Comentarios

Ejemplos

onDeleted

Tipo de evento

Comentarios