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 メソッドは、このイベントのイベント ハンドラを削除します。