OfficeExtension.EventHandlers class

Комментарии

Используется

Конструкторы

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

Создает новый экземпляр EventHandlers класса

Методы

add(handler)

Добавляет функцию, вызываемую при срабатывании события.

remove(handler)

Удаляет указанную функцию из списка обработчиков событий, чтобы она не вызывалась при последующих событиях.

Примечание: При удалении обработчика должен использоваться тот же объект RequestContext , в который был добавлен обработчик. Дополнительные сведения см. в статье Удаление обработчика событий.

Сведения о конструкторе

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

Создает новый экземпляр EventHandlers класса

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

Параметры

name

string

Сведения о методе

add(handler)

Добавляет функцию, вызываемую при срабатывании события.

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

Параметры

handler

(args: T) => Promise<any>

Функция, основанная на обещании, которая принимает все соответствующие аргументы события.

Возвращаемое значение

remove(handler)

Удаляет указанную функцию из списка обработчиков событий, чтобы она не вызывалась при последующих событиях.

Примечание: При удалении обработчика должен использоваться тот же объект RequestContext , в который был добавлен обработчик. Дополнительные сведения см. в статье Удаление обработчика событий.

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

Параметры

handler

(args: T) => Promise<any>

Ссылка на функцию, ранее предоставленную методу add в качестве обработчика событий.

Возвращаемое значение

void