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

BeginPrg (実行開始処理) 項目フックメソッド

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

この項目に関するプログラム起動時の初期設定処理を行う。なお、プログラムを起動してよいかどうかのチェックを行うこともできる。

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

ローカルピースに配置するか、または配置しない。セントラルピースに配置することは禁止されている。

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

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

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

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

なお、フック名としては、BeginPrg の他に実行開始処理を用いることができる。

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

プログラムの実行を開始して、画面の表示を行う前に (それぞれの項目ごとに 1 回だけ呼び出される)。 画面フックメソッド BeginPrg の直後に呼び出される。 画面フックメソッド BeginPrgALcl および項目フックメソッド BeginPrgALcl よりも前に呼び出される。

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

ItemBase.BEGINPRG_Allow (= True):　プログラムの開始を許可するので、起動処理を継続せよ。

ItemBase.BEGINPRG_Deny (= False):　プログラムの起動処理をやめて停止せよ。ItemBase は、この伝言を受けると、アプリ操作者からなされたプログラムの起動指示を無視して、プログラムの起動処理を取りやめる。

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

開始閉鎖許諾チェックオプションをオンにした場合に限って、戻り値の指定が有効となる。このオプションがオフの場合には、戻り値として ItemBase.BEGINPRG_Allow が指定されたものとみなされる。なお、このオプションは、ダイアログ画面オプションで指定できる。

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

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

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

特定の項目固有の初期設定処理は、画面フックメソッド BeginPrg や BeginPrgALcl ではなく、この項目フックメソッド BeginPrg, または BeginPrgALcl で行ってください。

セントラル側で行う初期設定処理は、この項目フックメソッドではなく、項目フックメソッド BeginPrgALcl，または画面フックメソッド BeginPrgALcl で行ってください。

複数の項目のそれぞれに項目フックメソッド BeginPrg が組み込まれている場合には、それらの呼出しの順序がどのようになってもよいように、プログラムを作成しておく必要がある。

◇ 関連事項

プログラムの実行開始に関係するフックメソッドには、 画面フックメソッド BeginPrg，項目フックメソッド BeginPrg (本フックメソッド)，画面フックメソッド BeginPrgALcl，項目フックメソッド BeginPrgALcl の四つがある。

初期設定の機能を果たす項目フックメソッドに Open があるが、この項目フックメソッドの方が先に呼び出される。

◇ 使用例

' 受注コード項目に関する実行開始時の処理を行う (BeginPrg)。
Friend Function 実行開始処理(ByVal fB As FormBase) As Boolean
    ' (ここに実行開始時に行う処理を記述します。)
    Return ItemBase.BEGINPRGALCL_Allow
End Function ' 実行開始処理

// 受注コード項目に関する実行開始時の処理を行う (BeginPrg)。
internal bool 実行開始処理( FormBase fB ) {
    // (ここに実行開始時に行う処理を記述します。)
    return ItemBase.BEGINPRGALCL_Allow;
} // 実行開始処理

// 受注コード項目に関する実行開始時の処理を行う (BeginPrg)。
boolean 実行開始処理( FormBase fB ) {
    // (ここに実行開始時に行う処理を記述します。)
    return ItemBase.BEGINPRGALCL_Allow;
} // 実行開始処理