Wizard Web サーバー コントロールの概要
更新 : 2007 年 11 月
Wizard コントロールを使用すると、ユーザー入力を収集する一連のフォームの作成に関連するタスクの多くを簡略化できます。
このトピックの内容は次のとおりです。
シナリオ
背景
コード例
クラス リファレンス
シナリオ
フォームを使用したユーザー入力の収集は、Web 開発において繰り返し発生するタスクです。タスクを実行するために使用するフォームのグループは、ウィザードと呼ばれます。
ASP.NET の Wizard コントロールは、複数のフォームの作成およびユーザー入力の収集に関連する多くのタスクを簡略化します。Wizard コントロールには、ステップの作成、新しいステップの追加、またはステップの順序変更を簡単に行うための単純な機構が用意されています。線形ナビゲーションや非線形ナビゲーションを作成し、コントロールのユーザー ナビゲーションをカスタマイズするためにコードを記述する必要はありません。
ページのトップへ
背景
相互に連結された一連のフォームを作成してデータ コレクションを分割する方法が一般的です。これを行うには、フォーム間のナビゲーション、データの永続性、およびステップごとの状態管理を管理します。Wizard コントロールでは、個々のステップを使用してデータを収集できます。ユーザーは自由にステップ間を移動できるため、ユーザーの操作が簡素化されます。ユーザーがさまざまなステップを実行している間は、コントロールが状態を保持します。したがって、開発者はページ間でのデータの保持を心配する必要はありません。
ウィザードのステップ
Wizard コントロールは、ステップを使用して異なるユーザー データ入力セクションを区別します。コントロール内の各ステップには、開始ステップ、中間ステップ、完了ステップのいずれであるかを示す StepType が与えられます。ウィザードは、必要な数だけ中間ステップを持つことができます。TextBox コントロールや ListBox コントロールなど、さまざまなコントロールを追加してユーザー入力を収集できます。Complete ステップに達すると、すべてのデータがアクセス可能になります。次のコード例では、2 つのステップを含む Wizard コントロールを示します。
<asp:Wizard ID="Wizard1" Runat="server">
<WizardSteps>
<asp:WizardStep Runat="server" Title="Step 1">
</asp:WizardStep>
<asp:WizardStep Runat="server" Title="Step 2">
</asp:WizardStep>
</WizardSteps>
</asp:Wizard>
各ステップ内では、コントロールとラベルを追加したり、ユーザー データを受け入れたりすることができます。Wizard コントロールは、表示するステップを管理し、収集されたデータの維持に役立ちます。
ウィザードのナビゲーション
Wizard コントロールは、線形ナビゲーションと非線形ナビゲーションの両方を提供します。コントロールの状態管理によって、ユーザーはステップ間を移動し、サイドバーが表示されている限り、任意のポイントで個々のステップを選択できます。コントロールのルート asp:Wizard 要素にあるナビゲーション用テキストは、StepNextButtonText プロパティ、StepPreviousButtonText プロパティ、および FinishCompleteButtonText プロパティを使用してカスタマイズできます。
<asp:Wizard ID="Wizard1" Runat="server"
StepNextButtonText=" Next >> "
StepPreviousButtonText=" << Previous "
FinishCompleteButtonText=" Done! ">
他の Wizard コントロール機能のカスタマイズ
Wizard コントロールは、タイトルおよびコントロールの現在のステップを自動的に表示します。タイトルは、HeaderText プロパティを使用してカスタマイズします。ヘッダーのテンプレートは、HeaderTemplate プロパティを使用して調整します。
DisplayCancelButton プロパティを true に設定してキャンセル ボタンを表示することもできます。
Wizard コントロールの NavigationButtonStyle プロパティは、すべてのボタンを共通のスタイルに設定するための簡単な方法を提供するだけでなく、各ボタンを個別にカスタマイズできる柔軟性を備えています。NavigationButtonStyle プロパティは、表示されるすべてのボタンに適用されます。ただし、このスタイルは、個々のボタンのスタイル プロパティを設定することによってオーバーライドできます。
ナビゲーション テンプレート
Wizard コントロールでは、StartNavigationTemplate プロパティ、FinishNavigationTemplate プロパティ、StepNavigationTemplate プロパティ、および SideBarTemplate プロパティを使用してコントロールのインターフェイスをさらにカスタマイズできるテンプレートをサポートしています。
Wizard コントロールのイベント
Wizard コントロールの動作は、カスタム コードおよびイベントを使用してカスタマイズできます。
たとえば、ユーザーが [次へ] ボタンをクリックしたときに発生する NextButtonClick イベントを受け取って、現在のステップのデータを取り込むことができます。このイベントに渡される WizardNavigationEventArgs パラメータには CurrentStepIndex プロパティと NextStepIndex プロパティが含まれるため、現在のステップおよび次のステップに基づいてコントロールの動作をカスタマイズしたり、[次へ] ボタンがクリックされたときにナビゲーションをキャンセルしたりできます。
同様に、PreviousButtonClick イベントおよび FinishButtonClick イベントを使用して [戻る] ボタンと [完了] ボタンの動作をカスタマイズできます。また、CancelButtonClick イベントを使用して、[キャンセル] ボタンがクリックされたときにクリーンアップを実行することもできます。
ページのトップへ
コード例
チュートリアル : 基本的な ASP.NET Wizard コントロールの作成
チュートリアル : ASP.NET Wizard コントロールの高度な操作方法
ページのトップへ
クラス リファレンス
Wizard コントロールに関連する主要なクラスの一覧を次の表に示します。
メンバ |
説明 |
|---|---|
コントロールのメイン クラスです。 |
|
Wizard コントロールのさまざまなナビゲーション イベントに必要なデータを提供します。 |
|
Wizard コントロールのナビゲーション イベントを処理するメソッドを表します。 |
|
Wizard コントロールに表示される基本的な手順を表します。 |
|
ページ開発者によって定義された、各ステップのユーザー インターフェイスを格納する WizardStep オブジェクトのコレクションを表します。 |
|
Wizard コントロールのステップで表示するナビゲーション UI の種類を指定します。 |
ページのトップへ