Excel.TableChangedEventArgs interface

  • Referencia
Paquete:
excel

Proporciona información sobre la tabla que generó el evento modificado.

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Propiedades

address

Obtiene la dirección que representa el área de cambio de una tabla en una hoja de cálculo concreta.
changeType

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

Obtiene 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.
tableId

Obtiene el identificador de la tabla en la que cambiaron los datos.
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 rango que representa el área modificada de una tabla en una hoja de cálculo específica.

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

Obtiene el rango que representa el área modificada de una tabla 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 que representa el área de cambio de una tabla en una hoja de cálculo concreta.

address: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

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

Obtiene 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

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

async function onTableChanged(eventArgs: Excel.TableChangedEventArgs) {
    await Excel.run(async (context) => {
        const details = eventArgs.details;
        const address = eventArgs.address;

        console.log(`Change at ${address}: was ${details.valueBefore}(${details.valueTypeBefore}),`
          + ` now is ${details.valueAfter}(${details.valueTypeAfter})`);
    });
}

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 ]

tableId

Obtiene el identificador de la tabla en la que cambiaron los datos.

tableId: string;

Valor de propiedad

string

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-tablecollection-changed.yaml

async function onChange(event) {
    await Excel.run(async (context) => {
        let table = context.workbook.tables.getItem(event.tableId);
        let worksheet = context.workbook.worksheets.getItem(event.worksheetId);
        worksheet.load("name");

        await context.sync();

        console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address);
        console.log("Table Id : " + event.tableId);
        console.log("Worksheet Id : " + worksheet.name);
    });
}

type

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

type: "TableChanged";

Valor de propiedad

"TableChanged"

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 ]

Ejemplos

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

async function onChange(event) {
    await Excel.run(async (context) => {
        let table = context.workbook.tables.getItem(event.tableId);
        let worksheet = context.workbook.worksheets.getItem(event.worksheetId);
        worksheet.load("name");

        await context.sync();

        console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address);
        console.log("Table Id : " + event.tableId);
        console.log("Worksheet Id : " + worksheet.name);
    });
}

Detalles del método

getRange(ctx)

Obtiene el rango que representa el área modificada de una tabla 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 rango que representa el área modificada de una tabla 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