监听修改字段的事件

FieldDescriptor.OnUpdate(方法)

说明

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

语法

表达式.OnUpdate(Callback)

表达式: FieldDescriptor

参数

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

返回值

EventContext

事件返回数据

FieldDescriptor

浏览器环境示例

async function example() {
    await instance.ready();
    const app = instance.Application;
    const fieldId = app.Sheets(1).FieldId('修改前字段名');
    const fieldDescriptor = app.Sheets(1).FieldDescriptors(fieldId);
    let eventContext
    eventContext = await fieldDescriptor.OnUpdate(data => {
        console.log(data);
        // 取消事件监听
        eventContext.Destroy()
    });

    fieldDescriptor.Name = '修改字段名';
    fieldDescriptor.Apply();
    //这里会执行OnUpdate的回调
}

脚本编辑器 示例

function main() {
    const fieldDescriptor = Application.Sheets(1).FieldDescriptors(1);
    let eventContext
    eventContext = fieldDescriptor.OnUpdate(data => {
        console.log(data);
        // 取消事件监听
        eventContext.Destroy()
    });
    fieldDescriptor.Name = '修改字段名';
    fieldDescriptor.Apply();
    //这里会执行OnUpdate的回调
}
main();