监听删除记录的事件

RecordRange.OnDeleteRecord(方法)

说明

为 RecordRange 添加 DeleteRecord 事件,当删除 RecordRange 时触发。注意在脚本编辑器中使用时，脚本运行结束就会退出运行，这时可能回调无法被正常触发

语法

表达式: OnDeleteRecord(Callback)

表达式: RecordRange

参数

参数名	是否必需	类型	描述
Callback	是	func	指定事件发生时的回调方法 ; const eventContext = await RecordRange.OnDeleteRecord(()=>{ ... })

返回值

EventContext

事件返回数据

名称	类型	说明
sheetId	Number	表的 Id
recordIds	Array	记录集合的 Ids

事件返回数据示例

{
    recordIds: ['A','C']
    sheetId: 1
}

浏览器环境示例

async function example() {
    await instance.ready();
    const app = instance.Application;
    let eventContext;
    eventContext = await app
        .Sheets(1)
        .Views(1)
        .RecordRange(1)
        .OnDeleteRecord(data => {
            console.log(data);
            // 取消事件监听
            eventContext.Destroy();
        });
    app.Sheets(1).Views(1).RecordRange(1).Delete();
    //这里会执行OnDeleteRecord的回调
}

脚本编辑器 示例

function main() {
    let eventContext;
    eventContext = Application.Sheets(1)
        .Views(1)
        .RecordRange(1)
        .OnDeleteRecord(data => {
            console.log(data);
            // 取消事件监听
            eventContext.Destroy();
        });
    Application.Sheets(1).Views(1).RecordRange(1).Delete();
    //这里会执行OnDeleteRecord的回调
}
main();