Excel.WorksheetChangedEventArgs interface

包:

excel

提供有关引发已更改事件的工作表的信息。

注解

[ API 集：ExcelApi 1.7 ]

属性

address	获取区域地址，该地址表示特定工作表上的更改区域。
changeType	获取表示更改事件的触发方式的更改类型。 有关详细信息，请参阅 Excel.DataChangeType。
details	表示有关更改详细信息的信息。 在单个单元格上触发更改事件时，可以检索此属性。 如果在多个单元格上触发了已更改的事件，则无法检索此属性。
source	获取事件源。 有关详细信息，请参阅 Excel.EventSource。
type	获取事件的类型。 有关详细信息，请参阅 Excel.EventType。
worksheetId	获取数据更改的工作表的 ID。

方法

getRange(ctx)	获取区域，该区域表示特定工作表上的更改区域。 [ API 集：ExcelApi 1.8 ]
getRangeOrNullObject(ctx)	获取区域，该区域表示特定工作表上的更改区域。 它可能会返回 null 对象。 [ API 集：ExcelApi 1.8 ]

属性详细信息

address

获取区域地址，该地址表示特定工作表上的更改区域。

address: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

changeType

获取表示更改事件的触发方式的更改类型。 有关详细信息，请参阅 Excel.DataChangeType。

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

属性值

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

注解

[ API 集：ExcelApi 1.7 ]

details

表示有关更改详细信息的信息。 在单个单元格上触发更改事件时，可以检索此属性。 如果在多个单元格上触发了已更改的事件，则无法检索此属性。

details: Excel.ChangedEventDetail;

属性值

Excel.ChangedEventDetail

注解

[ API 集：ExcelApi 1.9 ]

示例

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

获取事件源。 有关详细信息，请参阅 Excel.EventSource。

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

属性值

Excel.EventSource | "Local" | "Remote"

注解

[ API 集：ExcelApi 1.7 ]

type

获取事件的类型。 有关详细信息，请参阅 Excel.EventType。

type: "WorksheetChanged";

属性值

"WorksheetChanged"

注解

[ API 集：ExcelApi 1.7 ]

worksheetId

获取数据更改的工作表的 ID。

worksheetId: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

方法详细信息

getRange(ctx)

获取区域，该区域表示特定工作表上的更改区域。

[ API 集：ExcelApi 1.8 ]

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

参数

ctx

Excel.RequestContext

返回

Excel.Range

getRangeOrNullObject(ctx)

获取区域，该区域表示特定工作表上的更改区域。 它可能会返回 null 对象。

[ API 集：ExcelApi 1.8 ]

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

参数

ctx

Excel.RequestContext

返回

Excel.Range