OfficeExtension.EventHandlers class

Paquet:

office

Constructeurs

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

Construit une nouvelle instance de la EventHandlers classe

Méthodes

add(handler)	Ajoute une fonction à appeler lorsque l’événement est déclenché.
remove(handler)	Supprime la fonction spécifiée de la liste des gestionnaires d’événements afin qu’elle ne soit pas appelée sur les événements suivants. Remarque : le même objet RequestContext dans lequel le gestionnaire a été ajouté doit être utilisé lors de la suppression du gestionnaire. Pour plus d’informations, consultez Supprimer un gestionnaire d’événements.

Détails du constructeur

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

Construit une nouvelle instance de la EventHandlers classe

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

Paramètres

context

OfficeExtension.ClientRequestContext

parentObject

OfficeExtension.ClientObject

name

string

eventInfo

OfficeExtension.EventInfo<T>

Détails de la méthode

add(handler)

Ajoute une fonction à appeler lorsque l’événement est déclenché.

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

Paramètres

handler

(args: T) => Promise<any>

Fonction basée sur des promesses qui accepte tous les arguments d’événement pertinents.

Retours

OfficeExtension.EventHandlerResult<T>

remove(handler)

Supprime la fonction spécifiée de la liste des gestionnaires d’événements afin qu’elle ne soit pas appelée sur les événements suivants.

Remarque : le même objet RequestContext dans lequel le gestionnaire a été ajouté doit être utilisé lors de la suppression du gestionnaire. Pour plus d’informations, consultez Supprimer un gestionnaire d’événements.

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

Paramètres

handler

(args: T) => Promise<any>

Référence à une fonction précédemment fournie à la add méthode en tant que gestionnaire d’événements.

Retours

void