OnPreStageChange イベント (クライアント API リファレンス)
このイベントは、ビジネス プロセス フロー コントロールのステージが変更される 前 に発生します。 このイベントは、ユーザーがユーザー インターフェイスで 次のステージ、 前のステージに移動 、または アクティブ ステージの設定 ボタンを選択した後、または開発者が formContext.data.process.moveNext、 formContext.data.process.movePrevious、または formContext.data.process.setActiveStage メソッドを使用した場合に発生します。
注意
OnPreStageChange イベントは、統一インターフェイスでのみサポートされます。
開発者は、onPreStageChange イベントに登録されたWebリソース スクリプト内から、Webリソース スクリプトに渡された executionContext オブジェクトで以下を起動することができます:
executionContext.getEventArgs().preventDefault();
preventDefaultを呼び出すと:
- 状態の変更はされません。 プロセス インスタンスは当初のステージに残ります。
- クロステーブル ナビゲーションでは、デスティネーション ステージのテーブルのフォームは開きません。
- メインフォームの保存はされません。 メインフォームが処理途中の状態である場合、状態の変更はされません。
- onStageChange の登録を行ったWebリソースは呼び出されません。
実行コンテキスト オブジェクトは、このイベントのイベント ハンドラーに渡されます。 getEventArgs メソッドを使用して、次のメソッドを持つオブジェクトを取得できます。
- getDirection: ステージ変更の方向を示す
NextまたはPreviousの文字列を返します。 - getStage: ステージ オブジェクトを返します。 ナビゲーションが新規テーブルに移動する場合を除き、戻されたステージは目的のステージ オブジェクト、つまり次のアクティブ ステージを表します。 ナビゲーションが新規テーブルに移動する場合、ステージは移動元のステージ、つまり以前のアクティブ ステージ オブジェクトを表します。 詳細については、 ステージ メソッドを参照してください。
このイベントをサポートする方法
- formContext.data.process.addOnPreStageChange メソッドを使用して、このイベントのイベント ハンドラーを追加します。
- formContext.data.process.removeOnPreStageChange メソッドを使用して、このイベントのイベント ハンドラーを削除します。