跳到主要内容

如何绑定事件

您可以通过两种方式在编辑器中绑定事件。

选项 1:使用绑定编辑器事件方法

从 8.2 版本开始,在插件代码中定义绑定编辑器事件方法,以添加事件监听器。该事件监听器是一个函数,每当指定事件传递到目标时,该函数将被调用。

参数说明:

名称类型描述
idstring事件名称。
actionfunction事件监听函数。

返回值:

此方法无返回值。

示例:

Asc.plugin.attachEditorEvent("onAddComment", (data) => {
console.log(data);
});

选项 2:使用 attachEvent 方法

已废弃

从 8.2 版本开始,请改用 绑定编辑器事件 方法。

  1. 在 config.json 文件中,添加事件 参数,其中包含所有可用事件的数组:

    {
    "events": ["onAddComment"]
    }
  2. 在插件代码中定义绑定事件方法,以添加事件监听器。事件监听器是一个函数,每当指定事件传递到目标时,该函数将被调用:

    Asc.plugin.attachEvent(id, action);

参数:

名称类型描述
idstring事件名称。
actionfunction事件监听函数。

返回值:

此方法无返回值。

示例:

Asc.plugin.attachEvent("onAddComment", (data) => {
console.log(data);
});

您也可以使用 event_{event-name} 方法,其中 event_ 是每个事件方法的前缀,而 {event-name} 是任意事件的名称。例如:

Asc.plugin.event_onAddComment = (data) => {
console.log(data);
};

这些方法的工作方式与 attachEvent 方法相同。