OfficeExtension.EventHandlers class

Paket:

office

Konstruktoren

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

Erstellt eine neue Instanz 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 Ereignishandlerliste, sodass sie bei nachfolgenden Ereignissen nicht aufgerufen wird. Hinweis: Dasselbe RequestContext-Objekt , in dem der Handler hinzugefügt wurde, muss beim Entfernen des Handlers verwendet werden. Weitere Informationen finden Sie unter Entfernen eines Ereignishandlers.

Details zum Konstruktor

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

Erstellt eine neue Instanz der EventHandlers -Klasse

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

Parameter

context

OfficeExtension.ClientRequestContext

parentObject

OfficeExtension.ClientObject

name

string

eventInfo

OfficeExtension.EventInfo<T>

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 zusagebasierte Funktion, die alle relevanten Ereignisargumente akzeptiert.

Gibt zurück

OfficeExtension.EventHandlerResult<T>

remove(handler)

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

Hinweis: Dasselbe RequestContext-Objekt , in dem der Handler hinzugefügt wurde, muss beim Entfernen des Handlers verwendet werden. 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 der add -Methode zuvor als Ereignishandler bereitgestellt wurde.

Gibt zurück

void