OfficeExtension.EventHandlers class

Hinweise

Verwendet von

Konstruktoren

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

Erstellt eine neue Instance der EventHandlers Klasse

Methoden

add(handler)

Fügt eine Funktion hinzu, die aufgerufen werden soll, wenn das Ereignis ausgelöst wird.

remove(handler)

Entfernt die angegebene Funktion aus der Liste der Ereignishandler, sodass sie nicht bei nachfolgenden Ereignissen aufgerufen wird.

Hinweis: Beim Entfernen des Handlers muss dasselbe RequestContext-Objekt verwendet werden, in dem der Handler hinzugefügt wurde. Weitere Informationen finden Sie unter Entfernen eines Ereignishandlers.

Details zum Konstruktor

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

Erstellt eine neue Instance der EventHandlers Klasse

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

Parameter

name

string

Details zur Methode

add(handler)

Fügt eine Funktion hinzu, die aufgerufen werden soll, wenn das Ereignis ausgelöst wird.

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

Parameter

handler

(args: T) => Promise<any>

Eine zusagenbasierte Funktion, die alle relevanten Ereignisargumente berücksichtigt.

Gibt zurück

remove(handler)

Entfernt die angegebene Funktion aus der Liste der Ereignishandler, sodass sie nicht bei nachfolgenden Ereignissen aufgerufen wird.

Hinweis: Beim Entfernen des Handlers muss dasselbe RequestContext-Objekt verwendet werden, in dem der Handler hinzugefügt wurde. Weitere Informationen finden Sie unter Entfernen eines Ereignishandlers.

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

Parameter

handler

(args: T) => Promise<any>

Ein Verweis auf eine Funktion, die zuvor für die add Methode als Ereignishandler bereitgestellt wurde.

Gibt zurück

void