フック一覧　GetEvent (画面フック) 前の画面フック 次の画面フック

VB C# ALL プログラミング言語によるフィルタ (ここで選んだ言語で選別された説明や図だけが表示されます)

GetEvent (イベント処理) 画面フックメソッド

◇ 役割 (この画面フックメソッドに委託されている処理)

ある指示コントロールまたはファンクションキーに対してアプリ操作者が行った指示に反応して、その処理を行う。 どの指示コントロールまたはファンクションキーに反応すべきかは、コントロール略称 で指定する。

指示コントロールまたはファンクションキーは、利用者定義指示コントロール、および標準提供処理に対応づけられた既定義指示コントロールの 2 種類に分類される。 この画面フックメソッドは、コントロール略称の指定によってこれらのどちらの処理をすることもできるが、 既定義指示コントロールに対応するコントロール略称を指定することによって、その標準提供処理の内容を変更する (すりかえる) こともできる。

◇ 配置 (ツーピーススタイルの場合にこの画面フックメソッドをどこに配置できるか)

ローカルピースかセントラルピースかのどちらか一方に配置する。または、どちらにも配置しない。

◇ 代表的な書き方 (詳しい構文はフックメソッドの書き方を参照)

VB での書き方:
　Friend Function コントロール略称_GetEvent(パラメタ宣言列) As Boolean
　または
　Friend Function 画面略称_コントロール略称_GetEvent(パラメタ宣言列) As Boolean

C# での書き方:
　internal bool コントロール略称_GetEvent(パラメタ宣言列)
　または
　internal bool 画面略称_コントロール略称_GetEvent(パラメタ宣言列)

Java での書き方:
　boolean コントロール略称_GetEvent(パラメタ宣言列)
　または
　boolean 画面略称_コントロール略称_GetEvent(パラメタ宣言列)

フック名の前に書くコントロール略称 は、 文字入出力コントロール (テキストボックスやコンボボックスなど) の項目略称はなく、 ボタンやメニュー項目などの指示コントロールのコントロール略称である。 あるいはファンクションキーに割り当てた指示の名前をコントロール略称として指定する。

なお、フック名としては、GetEvent の他にイベント処理を用いることができる。

◇ 呼び出される契機 (以下が切っ掛けとなりこのフックメソッドが呼び出される)

アプリ操作者がボタンまたはメニューをクリックすることによって、 あるいはファンクションキーを押下することによって、コントロール略称で指定された指示コントロールへの指示がなされたとき。

◇ 戻り値の意味とデフォルト動作 (戻り値による FormBase への伝言)

FormBase.GETEVENT_Allow (= True):　もしもこのコントロール略称で指定される標準提供処理があれば､ このフックメソッドの後にそれを実施せよ。

FormBase.GETEVENT_Deny (= False):　もしもこのコントロール略称で指定される標準提供処理があれば､ それを実施するな。

このコントロール略称で指定される標準提供処理がない場合には､ 戻り値は意味をもたない。

デフォルト動作:　指示コントロールまたはファンクションキーに対する標準提供処理があれば、それが実施される。

◇ 代行メッセージ (処理の流れに応じて発せられるメッセージ; カスタマイズ可能)

(関係する代行メッセージなし)

◇ 使用上のヒントと注意事項

このフックメソッドを記述する際に、フック名の前には必ずコントロール略称 を付けることが必要である。

◇ 関連事項

この画面フックメソッドの他に、項目フックメソッド GetEvent もあり、文字入出力コントロールに対してアプリ操作者が行った操作を受け付けることができる。。

◇ 使用例

' 初画面ボタン (Cm_FirstButton) がクリックされたときにその処理を行う。
Friend Function FirstButton_GetEvent(ByVal fB As FormBase) As Boolean
    fB.MsgBox("初画面ボタンがクリックされました。")
    Return FormBase.GETEVENT_Allow
End Function ' FirstButton_GetEvent

// 初画面ボタン (Cm_FirstButton) がクリックされたときにその処理を行う。
internal bool FirstButton_GetEvent( FormBase fB ) {
    fB.MsgBox("初画面ボタンがクリックされました。");
    return FormBase.GETEVENT_Allow;
} // FirstButton_GetEvent

// 初画面ボタン (Cm_FirstButton) がクリックされたときにその処理を行う。
boolean FirstButton_GetEvent( FormBase fB ) {
    fB.MsgBox("初画面ボタンがクリックされました。");
    return FormBase.GETEVENT_Allow;
} // FirstButton_GetEvent