Compartir a través de

Excel.WorksheetChangedEventArgs interface

  • Referencia
Paquete:
excel

Proporciona información sobre la hoja de cálculo que generó el evento modificado.

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Propiedades

address

Obtiene la dirección del intervalo que representa el área que ha cambiado en una hoja de cálculo específica.
changeDirectionState

Representa un cambio en la dirección en que las celdas de una hoja de cálculo se desplazarán cuando se elimine o inserte una celda o celdas. Esto incluye los dos escenarios siguientes. 1. Dirección (por ejemplo, hacia abajo o hacia la derecha) que las celdas existentes se desplazarán cuando se inserte una nueva celda o celdas en una hoja de cálculo. 2. Dirección (por ejemplo, hacia arriba o hacia la izquierda) a la que se desplazarán las celdas restantes cuando se elimine una celda o celdas de una hoja de cálculo.
changeType

Obtiene el tipo de cambio que representa cómo se desencadena el evento modificado. Vea Excel.DataChangeType para más información.
details

Representa la información sobre los detalles del cambio. Esta propiedad se puede recuperar cuando se desencadena el evento modificado en una sola celda. Si el evento modificado se desencadena en varias celdas, esta propiedad no se puede recuperar.
source

Obtiene el origen del evento. Vea Excel.EventSource para más información.
triggerSource

Representa el origen del desencadenador del evento. Por ejemplo, identifica si este complemento local desencadena el evento.
type

Obtiene el tipo del evento. Vea Excel.EventType para más información.
worksheetId

Obtiene el identificador de la hoja de cálculo en la que cambiaron los datos.

Métodos

getRange(ctx)

Obtiene el intervalo que representa el área que ha cambiado en una hoja de cálculo específica.

[ Conjunto de API: ExcelApi 1.8 ]
getRangeOrNullObject(ctx)

Obtiene el intervalo que representa el área que ha cambiado en una hoja de cálculo específica. Puede devolver un objeto null.

[ Conjunto de API: ExcelApi 1.8 ]

Detalles de las propiedades

address

Obtiene la dirección del intervalo que representa el área que ha cambiado en una hoja de cálculo específica.

address: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

changeDirectionState

Representa un cambio en la dirección en que las celdas de una hoja de cálculo se desplazarán cuando se elimine o inserte una celda o celdas. Esto incluye los dos escenarios siguientes. 1. Dirección (por ejemplo, hacia abajo o hacia la derecha) que las celdas existentes se desplazarán cuando se inserte una nueva celda o celdas en una hoja de cálculo. 2. Dirección (por ejemplo, hacia arriba o hacia la izquierda) a la que se desplazarán las celdas restantes cuando se elimine una celda o celdas de una hoja de cálculo.

changeDirectionState: Excel.ChangeDirectionState;

Valor de propiedad

Excel.ChangeDirectionState

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Ejemplos

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

async function onChange(event: Excel.WorksheetChangedEventArgs) {
    // This function is an event handler that returns the address, trigger source, 
    // and insert or delete shift directions of the change.
    await Excel.run(async (context) => {
        // Return the address where change occurred.
        console.log(`Handler for worksheet onChanged event has been triggered.`);
        console.log(`    Data changed address: ` + event.address);

        // Return the source of the event that triggered the change.
        console.log(`    Data change trigger source: ` + event.triggerSource);

        // Note：insertShiftDirection and deleteShiftDirection are exclusive and both enums can't have a value at the same time. 
        // If one has a value, then the other will return undefined.

        // If the insert shift direction is defined, return it.
        if (event.changeDirectionState.insertShiftDirection) {
            console.log(`    Cells inserted shift direction: ` + event.changeDirectionState.insertShiftDirection);
        }

        // If the delete shift direction is defined, return it.
        if (event.changeDirectionState.deleteShiftDirection) {
            console.log(`    Cells deleted shift direction: ` + event.changeDirectionState.deleteShiftDirection);
        }
    });
}  

...

// This function deletes data from a range and sets the delete shift direction to "up".
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("A5:F5");
    range.delete(Excel.DeleteShiftDirection.up);
});

changeType

Obtiene el tipo de cambio que representa cómo se desencadena el evento modificado. Vea Excel.DataChangeType para más información.

changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted";

Valor de propiedad

Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted"

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

details

Representa la información sobre los detalles del cambio. Esta propiedad se puede recuperar cuando se desencadena el evento modificado en una sola celda. Si el evento modificado se desencadena en varias celdas, esta propiedad no se puede recuperar.

details: Excel.ChangedEventDetail;

Valor de propiedad

Excel.ChangedEventDetail

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

// This function would be used as an event handler for the Worksheet.onChanged event.
async function onWorksheetChanged(eventArgs) {
    await Excel.run(async (context) => {
        const details = eventArgs.details;
        const address = eventArgs.address;

        // Print the before and after types and values to the console.
        console.log(`Change at ${address}: was ${details.valueBefore}(${details.valueTypeBefore}),`
            + ` now is ${details.valueAfter}(${details.valueTypeAfter})`);
        await context.sync();
    });
}

source

Obtiene el origen del evento. Vea Excel.EventSource para más información.

source: Excel.EventSource | "Local" | "Remote";

Valor de propiedad

Excel.EventSource | "Local" | "Remote"

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

triggerSource

Representa el origen del desencadenador del evento. Por ejemplo, identifica si este complemento local desencadena el evento.

triggerSource: Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin";

Valor de propiedad

Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin"

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Ejemplos

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

async function onChange(event: Excel.WorksheetChangedEventArgs) {
    // This function is an event handler that returns the address, trigger source, 
    // and insert or delete shift directions of the change.
    await Excel.run(async (context) => {
        // Return the address where change occurred.
        console.log(`Handler for worksheet onChanged event has been triggered.`);
        console.log(`    Data changed address: ` + event.address);

        // Return the source of the event that triggered the change.
        console.log(`    Data change trigger source: ` + event.triggerSource);

        // Note：insertShiftDirection and deleteShiftDirection are exclusive and both enums can't have a value at the same time. 
        // If one has a value, then the other will return undefined.

        // If the insert shift direction is defined, return it.
        if (event.changeDirectionState.insertShiftDirection) {
            console.log(`    Cells inserted shift direction: ` + event.changeDirectionState.insertShiftDirection);
        }

        // If the delete shift direction is defined, return it.
        if (event.changeDirectionState.deleteShiftDirection) {
            console.log(`    Cells deleted shift direction: ` + event.changeDirectionState.deleteShiftDirection);
        }
    });
}

type

Obtiene el tipo del evento. Vea Excel.EventType para más información.

type: "WorksheetChanged";

Valor de propiedad

"WorksheetChanged"

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

worksheetId

Obtiene el identificador de la hoja de cálculo en la que cambiaron los datos.

worksheetId: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Detalles del método

getRange(ctx)

Obtiene el intervalo que representa el área que ha cambiado en una hoja de cálculo específica.

[ Conjunto de API: ExcelApi 1.8 ]

getRange(ctx: Excel.RequestContext): Excel.Range;

Parámetros

ctx
Excel.RequestContext

Devoluciones

Excel.Range

getRangeOrNullObject(ctx)

Obtiene el intervalo que representa el área que ha cambiado en una hoja de cálculo específica. Puede devolver un objeto null.

[ Conjunto de API: ExcelApi 1.8 ]

getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;

Parámetros

ctx
Excel.RequestContext

Devoluciones

Excel.Range