监听删除字段的事件

FieldDescriptor.OnDelete(方法)

说明

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

语法

表达式.OnDelete(Callback)

表达式: FieldDescriptor

参数

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

返回值

EventContext

事件返回数据

名称	类型	说明
sheetId	Number	表的 Id
fieldId	String	字段的 Id
fieldIds	Array	字段集合的 Ids

事件返回数据示例

{
    fieldId: "C"
    fieldIds: ['C']
    sheetId: 1
}

浏览器环境示例

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

脚本编辑器 示例

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