监听重命名视图的事件

View.OnRename(方法)

说明

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

语法

表达式.OnRename(Callback)

表达式: View

参数

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

返回值

EventContext

事件返回数据

名称	类型	说明
View	View	视图
originValue	String	原始值
value	String	修改后的值

事件返回数据示例

View, originValue, value

浏览器环境示例

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

脚本编辑器 示例

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