OfficeExtension.EventHandlers class

  • Referencia
Paquete:
office

Constructores

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

Construye una nueva instancia de la EventHandlers clase

Métodos

add(handler)

Agrega una función a la que se llamará cuando se desencadene el evento.
remove(handler)

Quita la función especificada de la lista de controladores de eventos para que no se llame a ella en eventos posteriores.

Nota: El mismo objeto RequestContext en el que se agregó el controlador debe usarse al quitar el controlador. Puede encontrar más información en Quitar un controlador de eventos.

Detalles del constructor

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

Construye una nueva instancia de la EventHandlers clase

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

Parámetros

context
OfficeExtension.ClientRequestContext
parentObject
OfficeExtension.ClientObject
name

string

eventInfo

OfficeExtension.EventInfo<T>

Detalles del método

add(handler)

Agrega una función a la que se llamará cuando se desencadene el evento.

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

Parámetros

handler

(args: T) => Promise<any>

Función basada en promesas que toma los argumentos de evento pertinentes.

Devoluciones

OfficeExtension.EventHandlerResult<T>

remove(handler)

Quita la función especificada de la lista de controladores de eventos para que no se llame a ella en eventos posteriores.

Nota: El mismo objeto RequestContext en el que se agregó el controlador debe usarse al quitar el controlador. Puede encontrar más información en Quitar un controlador de eventos.

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

Parámetros

handler

(args: T) => Promise<any>

Referencia a una función proporcionada anteriormente al add método como controlador de eventos.

Devoluciones

void