OfficeExtension.EventHandlers class

构造函数

(constructor)(context, parentObject, name, eventInfo)

构造 类的新实例EventHandlers

方法

add(handler)

添加在触发事件时要调用的函数。

remove(handler)

从事件处理程序列表中删除指定的函数,以便不会对后续事件调用指定函数。

注意:删除处理程序时,必须使用添加处理程序的同一 RequestContext 对象。 有关详细信息,请参阅 删除事件处理程序

构造函数详细信息

(constructor)(context, parentObject, name, eventInfo)

构造 类的新实例EventHandlers

constructor(context: ClientRequestContext, parentObject: ClientObject, name: string, eventInfo: EventInfo<T>);

参数

name

string

方法详细信息

add(handler)

添加在触发事件时要调用的函数。

add(handler: (args: T) => Promise<any>): EventHandlerResult<T>;

参数

handler

(args: T) => Promise<any>

一个基于承诺的函数,它采用任何相关的事件参数。

返回

remove(handler)

从事件处理程序列表中删除指定的函数,以便不会对后续事件调用指定函数。

注意:删除处理程序时,必须使用添加处理程序的同一 RequestContext 对象。 有关详细信息,请参阅 删除事件处理程序

remove(handler: (args: T) => Promise<any>): void;

参数

handler

(args: T) => Promise<any>

对函数的引用,该函数以前作为事件处理程序提供给 add 方法。

返回

void