v5.20192.624
|

Event クラス

イベントを表します。

Wijmoのイベントは.NETのイベントに似ています。どのクラスでも、 フィールドとして宣言することによってイベントを定義できます。 クラスでイベントをサブスクライブするには、イベントのaddHandler メソッドを使用し、 アンサブスクライブするには、removeHandler メソッドを使用します。

Wijmoのイベントハンドラは、senderargsの2つのパラメーターをとります。 最初のパラメータは、イベントを発生させたオブジェクトです。 2番目のパラメータは、イベントパラメータを含むオブジェクトです。

イベントを定義するクラスは、イベントごとにイベントを発生させる on[EVENTNAME] メソッドがあるという.NETのパターンに従います。 このパターンに従うと、派生クラスで on[EVENTNAME] メソッドをオーバーライドして、基本クラスがそのイベントを発生させる前または後にイベントを処理できます。 派生クラスでは、基本クラスの実装を呼び出さないようにすることで、 イベントを抑止することもできます。

たとえば、次のTypeScriptコードは、コントロールのvalueChangedイベントをオーバーライドして、 valueChangedイベントが発生する前後に何らかの処理を実行します。

// 基本クラスをオーバーライドします
onValueChanged(e: EventArgs) {
  // イベントが発生する前に何らかのコードを実行します
  console.log('about to fire valueChanged');
  // オプションで、基本クラスを呼び出してイベントを発生させます
  super.onValueChanged(e);
  // イベントが発生した後に何らかのコードを実行します
  console.log('valueChanged event just fired');
}

階層

  • Event

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

  • new Event(handlersChanged?: Function): Event
  • Event の新しいインスタンスを初期化します。

    引数

    • オプション handlersChanged: Function

      この {@link イベント} にハンドラが追加または削除されたときに呼び出されるオプションのコールバック。

    戻り値 Event

プロパティ

handlerCount

handlerCount: number

このイベントに追加されたハンドラの数を取得します。

hasHandlers

hasHandlers: boolean

このイベントがハンドラを持つかどうかを示す値を取得します。

メソッド

addHandler

  • addHandler(handler: IEventHandler, self?: any): void
  • このイベントにハンドラを追加します。

    引数

    • handler: IEventHandler

      イベントが発生したときに呼び出される関数。

    • オプション self: any

      イベントハンドラを定義するオブジェクト(ハンドラのコードから'this'としてアクセス可能)。

    戻り値 void

raise

  • このイベントを発生させます。これにより、関連付けられたすべてのハンドラが呼び出されます。

    引数

    • sender: any

      ソースオブジェクト。

    • オプション args: EventArgs

      イベントパラメーター。

    戻り値 void

removeAllHandlers

  • removeAllHandlers(): void
  • このイベントに関連付けられたすべてのハンドラを削除します。

    戻り値 void

removeHandler

  • removeHandler(handler: IEventHandler, self?: any): void
  • このイベントからハンドラを削除します。

    引数

    • handler: IEventHandler

      イベントが発生したときに呼び出される関数。

    • オプション self: any

      イベントハンドラを定義するオブジェクト(ハンドラのコードから'this'としてアクセス可能)。

    戻り値 void