WizardStepBase.AllowReturn プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

WizardStepBase.AllowReturn プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

ユーザーが WizardStepCollection コレクションの以降のステップから現在のステップに戻ることができるかどうかを示す値を取得します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

<ThemeableAttribute(False)> _
Public Overridable Property
 AllowReturn As Boolean

Visual Basic (使用法)

Dim instance As WizardStepBase
Dim value As Boolean

value = instance.AllowReturn

instance.AllowReturn = value

[ThemeableAttribute(false)] 
public virtual bool AllowReturn { get;
 set; }

C++

[ThemeableAttribute(false)] 
public:
virtual property bool AllowReturn {
    bool get ();
    void set (bool value);
}

/** @property */
public boolean get_AllowReturn ()

/** @property */
public void set_AllowReturn (boolean value)

JScript

public function get AllowReturn
 () : boolean

public function set AllowReturn
 (value : boolean)

プロパティ値
ユーザーが現在のステップに戻ることができる場合は true。それ以外の場合は false。既定値は true です。

解説

AllowReturn プロパティは、Wizard コントロールの線形ナビゲーションを強制するために使用されます。各ステップの AllowReturn プロパティを false に設定すると、ユーザーは既にアクセスしたステップに戻ることができなくなります。この機能は、各ステップの完了時にデータベースにデータを永続化するために、ユーザーが完了済みのステップに戻れないようにする場合などに使用します。各ステップの後にデータを保存する場合、ユーザーがあるステップに戻って保存済みの情報を変更できるようにすると、その保存されていたデータが破損する可能性があります。AllowReturn プロパティを false に設定すると、ユーザーは、一度ステップを完了したら、そのステップに戻って値を変更できなくなります。

AllowReturn プロパティは、[戻る] ボタンが表示されないようにする方法と場合を決定します。[戻る] ボタンの表示動作を次の表に示します。

シナリオ	動作
線形 : ステップ 1 で AllowReturn が false に設定され、ユーザーによる操作がステップ 2 に進んだ場合。	ステップ 2 で [戻る] ボタンは表示されません。
非線形 : ステップ 1 で AllowReturn が false に設定され、ユーザーによる操作でステップ 3 に進んだ場合。	ステップ 3 で [戻る] ボタンは表示されません。
サイドバーボタン : ステップ 2 で AllowReturn が false に設定され、DisplaySideBar が true に設定されていて、ユーザーがサイドバーボタンをクリックした場合。	AllowReturn が false に設定されている場合、サイドバーのボタンは自動的に無効になりません。ユーザーがボタンをクリックすると、その操作は無視されます。
カスタムテンプレートを使用した線形および非線形ナビゲーション : そのステップにカスタムナビゲーションテンプレートが存在する場合。	ナビゲーション用テンプレートを使用する場合、AllowReturn が false に設定されていると、自動非表示または自動表示は行われません。テンプレートで [戻る] ボタンが省略可能になっている必要があります。
Visual Studio デザイナおよび ActiveStepIndex を使用 : コントロールに 5 つのステップがあり、ステップ 4 を処理中でページを実行する場合。	ステップ 4 が ActiveStepIndex の場合、[戻る] ボタンが表示されます。履歴内の直前のステップで AllowReturn が false に設定されている場合、StepType が Step に設定されている場合だけ [戻る] ボタンが非表示になります。先にステップ 4 が表示され、履歴にステップが存在しないため、[戻る] ボタンは非表示になりません。
ステップの開始および非線形ナビゲーション : ユーザーがステップ 3 とステップ 4 に移動してから、StepType が Start に設定されているステップ 1 に移動した場合。	ユーザーがどのような方法でそのステップに移動したかに関係なく、StepType が Start に設定されている場合、ウィザードは [戻る] ボタンを追加しません。
履歴内の同一のステップ : ユーザーが、StepType が Step に設定されているステップ 3 に移動し、ステップ 3 の操作をコミットせず、ステップ 3 の [戻る] ボタンをクリックした場合。	ウィザードコントロールは、履歴内の [戻る] ステップが現在ユーザーに表示されているステップと "同じ" かどうかを確認します。ステップが同一である場合、ウィザードコントロールは、もう一度履歴に戻って直前の "異なる" ステップを確認し、履歴内の "異なるステップ" に基づいて [戻る] ボタンの表示と表示先を決定します。

メモ
AllowReturn プロパティを false に設定し、WizardStepBase の親コントロールの DisplaySideBar プロパティを true に設定した場合、サイドバー領域のボタンをクリックしても何も起こりません。一般にサイドバー領域は、非直線的なナビゲーションを提供するために表示されます。したがって、非直線的なナビゲーションの機能を使用しない場合は、DisplaySideBar プロパティを false に設定できます。

メモ

AllowReturn プロパティを false に設定し、WizardStepBase の親コントロールの DisplaySideBar プロパティを true に設定した場合、サイドバー領域のボタンをクリックしても何も起こりません。一般にサイドバー領域は、非直線的なナビゲーションを提供するために表示されます。したがって、非直線的なナビゲーションの機能を使用しない場合は、DisplaySideBar プロパティを false に設定できます。

このプロパティを、テーマまたはスタイルシートテーマを使用して設定することはできません。詳細については、ThemeableAttribute、ASP.NET のテーマとスキンの概要の各トピックを参照してください。

使用例

AllowReturn プロパティを使用して、Wizard コントロールのステップにアクセスした後でユーザーがそのステップに戻れないようにする方法を次のコード例に示します。この例では、Step1 ステップで AllowReturn プロパティを false に設定します。ユーザーが Step1 のステップを完了した後には、Step2 のステップに [戻る] ボタンは表示されません。

Visual Basic

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML
 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

</script>

<html  >
<body>
    <form id="form1" runat="server">
      <asp:Wizard id="Wizard1" 
        runat="server"
    displaysidebar="false" >
        <WizardSteps>
          <asp:WizardStep id="WizardStep1" 
            title="Step 1" 
            allowreturn="false"
            runat="server">
            You are currently on Step 1.
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep2" 
            title="Step 2" 
            runat="server">
            You are currently on Step 2.
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep3" 
            title="Step 3" 
            runat="server">
            You are currently on Step 3.
          </asp:WizardStep>
        </WizardSteps>
        <HeaderTemplate>
          <b>WizardStepBase AllowReturn Example</b>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

</script>

<html  >
<body>
    <form id="form1" runat="server">
      <asp:Wizard id="Wizard1" 
        runat="server"
    displaysidebar="false" >
        <WizardSteps>
          <asp:WizardStep id="WizardStep1" 
            title="Step 1" 
            allowreturn="false"
            runat="server">
            You are currently on Step 1.
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep2" 
            title="Step 2" 
            runat="server">
            You are currently on Step 2.
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep3" 
            title="Step 3" 
            runat="server">
            You are currently on Step 3.
          </asp:WizardStep>
        </WizardSteps>
        <HeaderTemplate>
          <b>WizardStepBase AllowReturn Example</b>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>