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

Prompt (案内表示開始) 項目フックメソッド

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

この項目に関するインプットの案内メッセージをステータス表示域に表示する。

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

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

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

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

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

Java での書き方:
　String Prompt(パラメタ宣言列)
　または
　String 項目略称_Prompt(パラメタ宣言列)

なお、フック名としては、Prompt の他に案内表示開始を用いることができる。

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

この項目にフォーカスが移ってきたとき。

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

ItemBase.PROMPT_NoValue (= Nothing):　ステータス表示域に表示されているメッセージの内容を変えない。

Nothing 以外のプロンプト (促進) メッセージの文字列:　このメッセージをステータス表示域に表示せよ。

デフォルト動作:　Prompt 画面フックメソッドが組み込まれていない場合の動作は、ItemBase.PROMPT_NoValue が設定された場合と同様である。

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

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

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

◇ 関連事項

この項目フックメソッドは、項目フックメソッド Unprompt と対をなす。

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

コントロールにフォーカスが移ってきたときに呼び出される画面フックメソッドに EachItem がある。

◇ 使用例

' 項目 AutoEnt のプロンプトメッセージを表示する。
Friend Function AutoEnt_Prompt(ByVal fB As FormBase) As String
    Return "E (Enter): 何をもって､ 項目へのインプットの完結とするかの指定です。"
End Function ' AutoEnt_Prompt

// 項目 AutoEnt のプロンプトメッセージを表示する。
internal string AutoEnt_Prompt( FormBase fB ) {
    return "E (Enter): 何をもって､ 項目へのインプットの完結とするかの指定です。";
} // AutoEnt_Prompt

// 項目 AutoEnt のプロンプトメッセージを表示する。
String AutoEnt_Prompt( FormBase fB ) {
    return "E (Enter): 何をもって､ 項目へのインプットの完結とするかの指定です。";
} // AutoEnt_Prompt