Excel.TableChangedEventArgs interface

Pacote:

excel

Fornece informações sobre a tabela que levantou o evento alterado.

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Propriedades

address	Obtém o endereço que representa a área alterada de uma tabela em uma planilha específica.
changeType	Obtém o tipo de alteração que representa como o evento alterado é disparado. Confira Excel.DataChangeType detalhes.
details	Obtém as informações sobre os detalhes da alteração. Essa propriedade pode ser recuperada quando o evento alterado é disparado em uma única célula. Se o evento alterado for disparado em várias células, essa propriedade não poderá ser recuperada.
source	Obtém a origem do evento. Confira Excel.EventSource detalhes.
tableId	Obtém a ID da tabela na qual os dados foram alterados.
type	Obtém o tipo do evento. Confira Excel.EventType detalhes.
worksheetId	Obtém a ID da planilha na qual os dados foram alterados.

Métodos

getRange(ctx)	Obtém o intervalo que representa a área alterada de uma tabela em uma planilha específica. [ Conjunto de API: ExcelApi 1.8 ]
getRangeOrNullObject(ctx)	Obtém o intervalo que representa a área alterada de uma tabela em uma planilha específica. Pode retornar o objeto null. [ Conjunto de API: ExcelApi 1.8 ]

Detalhes da propriedade

address

Obtém o endereço que representa a área alterada de uma tabela em uma planilha específica.

address: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

changeType

Obtém o tipo de alteração que representa como o evento alterado é disparado. Confira Excel.DataChangeType detalhes.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

details

Obtém as informações sobre os detalhes da alteração. Essa propriedade pode ser recuperada quando o evento alterado é disparado em uma única célula. Se o evento alterado for disparado em várias células, essa propriedade não poderá ser recuperada.

details: Excel.ChangedEventDetail;

Valor da propriedade

Excel.ChangedEventDetail

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// 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

Obtém a origem do evento. Confira Excel.EventSource detalhes.

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

Valor da propriedade

Excel.EventSource | "Local" | "Remote"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

tableId

Obtém a ID da tabela na qual os dados foram alterados.

tableId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// 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

Obtém o tipo do evento. Confira Excel.EventType detalhes.

type: "TableChanged";

Valor da propriedade

"TableChanged"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

worksheetId

Obtém a ID da planilha na qual os dados foram alterados.

worksheetId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

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

Detalhes do método

getRange(ctx)

Obtém o intervalo que representa a área alterada de uma tabela em uma planilha específica.

[ Conjunto de API: ExcelApi 1.8 ]

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

Parâmetros

ctx

Excel.RequestContext

Retornos

Excel.Range

getRangeOrNullObject(ctx)

Obtém o intervalo que representa a área alterada de uma tabela em uma planilha específica. Pode retornar o objeto null.

[ Conjunto de API: ExcelApi 1.8 ]

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

Parâmetros

ctx

Excel.RequestContext

Retornos

Excel.Range