监听增加字段的事件

FieldDescriptors.OnCreate(方法)

说明

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

语法

表达式.OnCreate(Callback)

表达式: FieldDescriptors

参数

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

返回值

EventContext

事件返回数据

FieldDescriptor

浏览器环境示例

async function example() {
    await instance.ready();
    const app = instance.Application;
    let eventContext;
    eventContext = await app.Sheets(1).FieldDescriptors.OnCreate(data => {
        console.log(data);
        // 取消事件监听
        eventContext.Destroy();
    });
    const desc = await app.FieldDescriptor('Rating', '等级字段');
    desc.MaxRating = 2;
    await app.Sheets(1).FieldDescriptors.AddField(desc, 1);
    //这里会执行OnCreate的回调
}

脚本编辑器 示例

function main() {
    let eventContext;
    eventContext = Application.Sheets(1).FieldDescriptors.OnCreate(data => {
        console.log(data);
        // 取消事件监听
        eventContext.Destroy();
    });
    const desc = Application.FieldDescriptor('Rating', '等级字段');
    desc.MaxRating = 2;
    Application.Sheets(1).FieldDescriptors.AddField(desc, 1);
    //这里会执行OnCreate的回调
}
main();