OfficeExtension.EventHandlers class
Constructeurs
(constructor)(context, parent |
Construit une nouvelle instance de la |
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 du handler d’événements afin qu’elle ne soit pas appelée lors des événements suivants. Remarque: le même objet RequestContext que le handler a été ajouté doit être utilisé lors de la suppression du handler. Pour plus d’informations, voir Supprimer un handler 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
- parentObject
- OfficeExtension.ClientObject
- name
-
string
- eventInfo
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 une promesse qui prend tous les arguments d’événement pertinents.
Retours
remove(handler)
Supprime la fonction spécifiée de la liste du handler d’événements afin qu’elle ne soit pas appelée lors des événements suivants.
Remarque: le même objet RequestContext que le handler a été ajouté doit être utilisé lors de la suppression du handler. Pour plus d’informations, voir Supprimer un handler 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 méthode en tant add
que handler d’événements.
Retours
void