SPEvent class
Stellt ein Frameworkereignis dar, das Komponenten abonnieren können.
Hinweise
Beispiele für Ereignisse in einer Webanwendung können sein: der Benutzer, der auf eine Schaltfläche klickt, das System, das zu einer anderen Seite navigiert, oder ein Element, das einer abstrakten Sammlung hinzugefügt/entfernt wird. Die SharePoint-Framework stellt Ereignisse mithilfe von Instanzen des SPEvent-Objekts dar, eine für jede Art von Ereignis. Das SPEvent-Objekt wird in der Regel als Eigenschaft einer zugeordneten Klasse verfügbar gemacht (z. B. die Schaltfläche, auf die geklickt werden kann). Wenn eine Komponente an einem Ereignis interessiert ist, ruft sie add() auf, um einen Ereignishandlerrückruf zu registrieren, der bei jedem Auftreten des Ereignisses aufgerufen wird. Der Handler empfängt einen SPEventArgs-Parameter, der zusätzliche Details zum Geschehen bereitstellen kann. Dies entspricht den DOM-Ereignissen (Document Object Model) des Browsers. Der Standard Unterschied besteht in der ISPEventObserver-Funktion, die nachverfolgt, welche Komponente jedes Ereignis abonniert hat, und den Handler automatisch abbestellt, wenn die Komponente verworfen wird.
Wenn ein Ereignis ausgelöst wird, werden alle Handler synchron aufgerufen. Die Reihenfolge, in der Ereignishandler aufgerufen werden, ist nicht angegeben. Der Ereignishandlerrückruf muss alle Ausnahmen abfangen, die während der Verarbeitung auftreten. Eine nicht abgefangene Ausnahme verhindert nicht, dass andere Handler ausgeführt werden, aber sie wird als Problem mit der zugeordneten Komponente gemeldet.
Der Konstruktor für diese Klasse ist als intern gekennzeichnet. Drittanbietercode sollte den Konstruktor nicht direkt aufrufen oder Unterklassen erstellen, die die Klasse SPEvent erweitern.
Methoden
| add(observer, event |
Registriert einen Rückruf, der immer dann aufgerufen wird, wenn das Ereignis eintritt. |
| remove(observer, event |
Hebt die Registrierung eines Rückrufs auf, der mit add() registriert wurde. |
Details zur Methode
add(observer, eventHandler)
Registriert einen Rückruf, der immer dann aufgerufen wird, wenn das Ereignis eintritt.
add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;Parameter
- observer
- ISPEventObserver
Gibt das Objekt an, das das Ereignis abonniert: Wenn das Objekt verworfen wird, wird der Ereignishandler automatisch entfernt. Dieses Objekt wird auch für Diagnosezwecke verwendet, z. B. um zu erkennen, ob der Ereignishandler eine Ausnahme nicht abfangen konnte.
- eventHandler
-
(eventArgs: TEventArgs) => void
Eine Rückruffunktion, die immer dann aufgerufen wird, wenn das Ereignis eintritt
Gibt zurück
void
Hinweise
Dasselbe Objekt kann demselben Ereignis mehrere Ereignishandler hinzufügen. Da BaseComponent die ISPEventObserver-Schnittstelle implementiert, kann sich ein Webpart oder eine Erweiterung selbst als Beobachter übergeben. Dies führt dazu, dass der Ereignishandler automatisch abbestellt wird, wenn das Webpart oder die Erweiterung verworfen wird.
remove(observer, eventHandler)
Hebt die Registrierung eines Rückrufs auf, der mit add() registriert wurde.
remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;Parameter
- observer
- ISPEventObserver
Dies muss derselbe Beobachter sein, der an die add()-Funktion übergeben wurde.
- eventHandler
-
(eventArgs: TEventArgs) => void
Der zu entfernende Ereignishandler; Dies muss das gleiche Objekt instance sein, das an die add()-Funktion übergeben wurde.
Gibt zurück
void
Hinweise
Wenn der Ereignishandler bereits entfernt wurde oder nie hinzugefügt wurde, hat diese Methode keine Auswirkungen.