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

Help (ヘルプ表示) 項目フックメソッド

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

この項目に関するヘルプメッセージを表示する。

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

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

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

VB での書き方:
　Friend Function Help(パラメタ宣言列) As Boolean
　または
　Friend Function 項目略称_Help(パラメタ宣言列) As Boolean

C# での書き方:
　internal bool Help(パラメタ宣言列)
　または
　internal bool 項目略称_Help(パラメタ宣言列)

Java での書き方:
　boolean Help(パラメタ宣言列)
　または
　boolean 項目略称_Help(パラメタ宣言列)

なお、フック名としては、Help の他にヘルプ表示を用いることができる。

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

アプリ操作者からこの項目に関する Help 指示がなされたとき。

この項目に関する Help 指示とは、この項目にカーソルがあるときに、アプリ操作者がボタン Cm_Help をクリックすること、またはメニュー項目 Mn_Help をクリックすることか、これに相当する操作 (対応するショートカットキーの押下) をすること、または Help に対応づけられたファンクションキーを押下することを意味する。

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

(戻り値に意味なし)

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

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

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

この項目に対応するコントロールは、RadioButton であってはならない。

◇ 関連事項

アプリ操作者へのインプットの案内の役割を果たす項目フックメソッドには、この他に Prompt がある。

◇ 使用例

' 得意先コードにフォーカスがあるとき Help 指示で動作する。
Friend Function TokuiCd_Help(ByVal fB As FormBase) As Boolean
    fB.MsgBox("得意先コードは 4 桁の数字です。", MsgBoxStyle.Information, "ヘルプ", Nothing)
    Return True
End Function ' TokuiCd_Help

// 得意先コードにフォーカスがあるとき Help 指示で動作する。
internal bool TokuiCd_Help( FormBase fB ) {
    fB.MsgBox("得意先コードは 4 桁の数字です。", MsgBoxStyle.Information, "ヘルプ", null);
    return true;
} // TokuiCd_Help

// 得意先コードにフォーカスがあるとき Help 指示で動作する。
boolean TokuiCd_Help( FormBase fB ) {
    fB.MessageBoxShow("得意先コードは 4 桁の数字です。", "ヘルプ",
                      MessageBoxIcon.Information);
    return true;
} // TokuiCd_Help