OfficeExtension.EventHandlers class
Construtores
(constructor)(context, parent |
Constrói uma nova instância da |
Métodos
add(handler) | Adiciona uma função a ser chamada quando o evento é disparado. |
remove(handler) | Remove a função especificada da lista de manipuladores de eventos para que ela não seja chamada em eventos subsequentes. Observação: o mesmo objeto RequestContext no qual o manipulador foi adicionado deve ser usado ao remover o manipulador. Mais informações podem ser encontradas em Remover um manipulador de eventos. |
Detalhes do construtor
(constructor)(context, parentObject, name, eventInfo)
Constrói uma nova instância da EventHandlers
classe
constructor(context: ClientRequestContext, parentObject: ClientObject, name: string, eventInfo: EventInfo<T>);
Parâmetros
- parentObject
- OfficeExtension.ClientObject
- name
-
string
- eventInfo
Detalhes do método
add(handler)
Adiciona uma função a ser chamada quando o evento é disparado.
add(handler: (args: T) => Promise<any>): EventHandlerResult<T>;
Parâmetros
- handler
-
(args: T) => Promise<any>
Uma função baseada em promessas que usa quaisquer argumentos de evento relevantes.
Retornos
remove(handler)
Remove a função especificada da lista de manipuladores de eventos para que ela não seja chamada em eventos subsequentes.
Observação: o mesmo objeto RequestContext no qual o manipulador foi adicionado deve ser usado ao remover o manipulador. Mais informações podem ser encontradas em Remover um manipulador de eventos.
remove(handler: (args: T) => Promise<any>): void;
Parâmetros
- handler
-
(args: T) => Promise<any>
Uma referência a uma função fornecida anteriormente ao add
método como manipulador de eventos.
Retornos
void