SPEvent class
Représente un événement d’infrastructure auquel les composants peuvent s’abonner.
Remarques
Voici quelques exemples d’événements dans une application web : l’utilisateur qui clique sur un bouton, le système navigue vers une autre page ou un élément ajouté/supprimé d’une collection abstraite. La SharePoint Framework représente les événements à l’aide d’instances de l’objet SPEvent, une pour chaque type d’événement. L’objet SPEvent est généralement exposé en tant que propriété d’une classe associée (par exemple, le bouton sur lequel vous pouvez cliquer). Lorsqu’un composant est intéressé par un événement, il appelle add() pour inscrire un rappel de gestionnaire d’événements qui sera appelé chaque fois que l’événement se produit. Le gestionnaire reçoit un paramètre SPEventArgs qui peut fournir des détails supplémentaires sur ce qui s’est passé. Cela est analogue aux événements DOM (Document Object Model) du navigateur. La principale différence est la fonctionnalité ISPEventObserver, qui effectue le suivi du composant abonné à chaque événement et annule automatiquement le gestionnaire lorsque le composant est supprimé.
Lorsqu’un événement est déclenché, tous les gestionnaires sont appelés de manière synchrone. L’ordre dans lequel les gestionnaires d’événements sont appelés n’est pas spécifié. Le rappel du gestionnaire d’événements doit intercepter toutes les exceptions qui se produisent pendant le traitement ; Une exception non interceptée n’empêche pas d’autres gestionnaires de s’exécuter, mais elle est signalée comme un problème avec le composant associé.
Le constructeur de cette classe est marqué comme interne. Le code tiers ne doit pas appeler directement le constructeur ou créer des sous-classes qui étendent la SPEvent classe.
Méthodes
| add(observer, event |
Inscrit un rappel qui sera appelé chaque fois que l’événement se produit. |
| remove(observer, event |
Annule l’inscription d’un rappel qui a été inscrit à l’aide de add(). |
Détails de la méthode
add(observer, eventHandler)
Inscrit un rappel qui sera appelé chaque fois que l’événement se produit.
add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;Paramètres
- observer
- ISPEventObserver
Indique l’objet qui s’abonne à l’événement : lorsque l’objet est supprimé, le gestionnaire d’événements est automatiquement supprimé. Cet objet est également utilisé à des fins de diagnostic, par exemple pour détecter si le gestionnaire d’événements n’a pas réussi à intercepter une exception.
- eventHandler
-
(eventArgs: TEventArgs) => void
Fonction de rappel qui sera appelée chaque fois que l’événement se produit
Retours
void
Remarques
Le même objet peut ajouter plusieurs gestionnaires d’événements au même événement. Étant donné que BaseComponent implémente l’interface ISPEventObserver, un composant WebPart ou une extension peut se transmettre en tant qu’observateur. Cela entraîne la désinscription automatique du gestionnaire d’événements lorsque le composant WebPart ou l’extension est supprimé.
remove(observer, eventHandler)
Annule l’inscription d’un rappel qui a été inscrit à l’aide de add().
remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;Paramètres
- observer
- ISPEventObserver
Il doit s’agir du même observateur que celui qui a été passé à la fonction add().
- eventHandler
-
(eventArgs: TEventArgs) => void
Gestionnaire d’événements à supprimer ; il doit s’agir de la même instance d’objet que celle qui a été passée à la fonction add().
Retours
void
Remarques
Si le gestionnaire d’événements a déjà été supprimé ou s’il n’a jamais été ajouté, cette méthode n’a aucun effet.