OfficeExtension.EventHandlers class

  • Referência
Pacote:
office

Construtores

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

Constrói uma nova instância da EventHandlers classe

Métodos

add(handler)

Adiciona uma função a ser chamada quando o evento é acionado.
remove(handler)

Remove a função especificada da lista de processadores de eventos para que não seja chamada em eventos subsequentes.

Nota: o mesmo objeto RequestContext no qual o processador foi adicionado tem de ser utilizado ao remover o processador. Pode encontrar mais informações em Remover um processador 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

context
OfficeExtension.ClientRequestContext
parentObject
OfficeExtension.ClientObject
name

string

eventInfo

OfficeExtension.EventInfo<T>

Detalhes do método

add(handler)

Adiciona uma função a ser chamada quando o evento é acionado.

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

Parâmetros

handler

(args: T) => Promise<any>

Uma função baseada em promessas que recebe todos os argumentos de evento relevantes.

Retornos

OfficeExtension.EventHandlerResult<T>

remove(handler)

Remove a função especificada da lista de processadores de eventos para que não seja chamada em eventos subsequentes.

Nota: o mesmo objeto RequestContext no qual o processador foi adicionado tem de ser utilizado ao remover o processador. Pode encontrar mais informações em Remover um processador 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 um processador de eventos.

Retornos

void