Excel.WorksheetChangedEventArgs interface

Fornece informações sobre a planilha que gerou o evento alterado.

Propriedades

address

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

changeType

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

details

Representa 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. Consulte Excel.EventSource para obter detalhes.

type

Obtém o tipo do evento. Consulte Excel.EventType para obter 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 planilha específica.

Conjunto de APIs: ExcelApi 1.8

getRangeOrNullObject(ctx)

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

Conjunto de APIs: ExcelApi 1.8

Detalhes da propriedade

address

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

address: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.7

changeType

Obtém o tipo de alteração que representa como o evento alterado é disparado. Consulte Excel.DataChangeType para obter 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 APIs: ExcelApi 1.7

details

Representa 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

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

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

Obtém a origem do evento. Consulte Excel.EventSource para obter detalhes.

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

Valor da propriedade

Excel.EventSource | "Local" | "Remote"

Comentários

Conjunto de APIs: ExcelApi 1.7

type

Obtém o tipo do evento. Consulte Excel.EventType para obter detalhes.

type: "WorksheetChanged";

Valor da propriedade

"WorksheetChanged"

Comentários

Conjunto de APIs: 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 APIs: ExcelApi 1.7

Detalhes do método

getRange(ctx)

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

Conjunto de APIs: ExcelApi 1.8

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

Parâmetros

Retornos

getRangeOrNullObject(ctx)

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

Conjunto de APIs: ExcelApi 1.8

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

Parâmetros

Retornos