监听增加数据表的事件
说明
为当前数据表集合添加 CreateSheet 事件(当前只支持添加数据表事件,添加说明页和仪表盘不会触发该事件,后续版本更新后支持),当新增 sheet 时触发。注意在脚本编辑器中使用时,脚本运行结束就会退出运行,这时可能回调无法被正常触发
语法
表达式: OnCreateSheet(Callback)
表达式: Sheets
参数
参数名 | 是否必需 | 类型 | 描述 |
---|---|---|---|
Callback | 是 | func | 指定事件发生时的回调方法 ; const eventContext = await Sheets.OnCreateSheet(()=>{ ... }) |
返回值
EventContext
事件返回数据
名称 | 类型 | 说明 |
---|---|---|
Sheet | Sheet | 表 |
浏览器环境示例
javascript
async function example() {
await instance.ready();
const app = instance.Application;
let eventContext;
eventContext = await app.Sheets.OnCreateSheet(data => {
console.log(data);
// 取消事件监听
eventContext.Destroy();
});
await app.Sheets.Add({ Type: 'xlEtDataBaseSheet' });
//这里会执行OnCreateSheet的回调
}
脚本编辑器 示例
javascript
function main() {
let eventContext;
eventContext = Application.Sheets.OnCreateSheet(data => {
console.log(data);
// 取消事件监听
eventContext.Destroy();
});
Application.Sheets.Add({ Type: 'xlEtDataBaseSheet' });
//这里会执行OnCreateSheet的回调
}
main();