OfficeExtension.EventHandlers class

  • Ссылка
Пакет:
office

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

(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>);

Параметры

context
OfficeExtension.ClientRequestContext
parentObject
OfficeExtension.ClientObject
name

string

eventInfo

OfficeExtension.EventInfo<T>

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

add(handler)

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

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

Параметры

handler

(args: T) => Promise<any>

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

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

OfficeExtension.EventHandlerResult<T>

remove(handler)

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

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

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

Параметры

handler

(args: T) => Promise<any>

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

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

void