OfficeExtension.EventHandlers class
コンストラクター
| (constructor)(context, parent |
|
メソッド
| add(handler) | イベントがトリガーされたときに呼び出される関数を追加します。 |
| remove(handler) | 指定した関数をイベント ハンドラー リストから削除して、後続のイベントで呼び出されないようにします。 注: ハンドラーを削除するときは、ハンドラーが追加されたのと同じ RequestContext オブジェクトを使用する必要があります。 詳細については、「 イベント ハンドラーの削除」を参照してください。 |
コンストラクターの詳細
(constructor)(context, parentObject, name, eventInfo)
EventHandlers クラスの新しいインスタンスを構築します
constructor(context: ClientRequestContext, parentObject: ClientObject, name: string, eventInfo: EventInfo<T>);パラメーター
- parentObject
- OfficeExtension.ClientObject
- name
-
string
- eventInfo
メソッドの詳細
add(handler)
イベントがトリガーされたときに呼び出される関数を追加します。
add(handler: (args: T) => Promise<any>): EventHandlerResult<T>;パラメーター
- handler
-
(args: T) => Promise<any>
関連するイベント引数を受け取る promise ベースの関数。
戻り値
remove(handler)
指定した関数をイベント ハンドラー リストから削除して、後続のイベントで呼び出されないようにします。
注: ハンドラーを削除するときは、ハンドラーが追加されたのと同じ RequestContext オブジェクトを使用する必要があります。 詳細については、「 イベント ハンドラーの削除」を参照してください。
remove(handler: (args: T) => Promise<any>): void;パラメーター
- handler
-
(args: T) => Promise<any>
イベント ハンドラーとして add メソッドに以前に指定した関数への参照。
戻り値
void