WizardStepBase.AllowReturn プロパティ

  • リファレンス

定義

名前空間:
System.Web.UI.WebControls
アセンブリ:
System.Web.dll

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

public:
 virtual property bool AllowReturn { bool get(); void set(bool value); };
[System.Web.UI.Themeable(false)]
public virtual bool AllowReturn { get; set; }
[<System.Web.UI.Themeable(false)>]
member this.AllowReturn : bool with get, set
Public Overridable Property AllowReturn As Boolean

プロパティ値

Boolean

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

属性
ThemeableAttribute

例

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

<%@ 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 xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ASP.NET Example</title>
</head>
<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="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 xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ASP.NET Example</title>
</head>
<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>

注釈

プロパティを AllowReturn 使用して、コントロールに線形ナビゲーションを Wizard 適用できます。 各ステップの AllowReturn プロパティが に false設定されている場合、ユーザーはアクセス後にステップに戻ることができません。 この機能を使用するシナリオの 1 つは、各ステップの完了時にデータをデータベースに保持するため、完了した後にユーザーがステップに戻りを禁止することです。 各ステップの後にデータを保存し、ユーザーがステップに戻り、保存後に情報を変更できるようにすると、保存されたデータが破損する可能性があります。 ユーザーがステップを終了したら、 AllowReturn プロパティを に false設定すると、そのプロパティに戻って値を変更できなくなります。

プロパティは AllowReturn 、[ 前へ] ボタンがレンダリングされない方法とタイミングを決定します。 次の表では、[ 前へ] ボタンのレンダリング動作について説明します。

シナリオ 動作
線形: ステップ 1 は AllowReturn に false 設定されており、ユーザー アクションは手順 2 に進みます。 手順 2 では、[ 前へ ] ボタンは表示されません。
非線形: Step1 が にfalse設定されており、ユーザー アクションはAllowReturn手順 3 に進みます。 手順 3 では、[ 前へ ] ボタンは表示されません。
SideBar ボタン: 手順 2 で AllowReturn が にfalseDisplaySideBar設定され、 が にtrue設定され、ユーザーが [SideBar] ボタンをクリックします。 が に設定されている場合 AllowReturn 、サイドバーのボタンは自動的に false無効にされません。 ユーザーがボタンをクリックすると、アクションは無視されます。
線形 & カスタム テンプレートを使用した非線形: この手順には、カスタム ナビゲーション テンプレートがあります。 ナビゲーションにテンプレートを使用するときに が にfalse設定されている場合AllowReturn、自動非表示または表示は行われません。 テンプレートの [ 前へ] ボタンは省略可能である必要があります。
Visual Studio Designer と ActiveStepIndex を使用する: コントロールには 5 つの手順があり、手順 4 で作業し、ページを実行します。 手順 4 が の ActiveStepIndex場合は、[ 前へ ] ボタンがレンダリングされます。 [前へ] ボタンは、履歴の前のステップが にStep設定されているAllowReturn場合にのみ 非表示StepTypefalseになります。 手順 4 は最初にレンダリングされ、履歴にステップがないため、[ 前へ ] ボタンは非表示になりません。
ステップと非線形ナビゲーションを開始する: ユーザーは、手順 3 と手順 4 にアクセスし、次に に設定されている StepType 手順 1 に Startアクセスします。 が に設定されている場合StepType、ユーザーがそのステップにStart移動する方法に関係なく、ウィザードで [前へ] ボタンは追加されません。
履歴内の同じステップ: ユーザーがステップ 3 にアクセスします。ここで StepType 、 は に Step 設定され、ユーザーは自分のアクションをコミットしません。 次に、手順 3 の前のボタンをクリックします。 ウィザード コントロールは、履歴の [前 へ] ステップが、ユーザーが現在オンになっている "同じ" ステップであるかどうかを確認します。 ステップが同じ場合、ウィザード コントロールは履歴を振り返り、前の "異なる" ステップを判断し、履歴の "異なるステップ" に基づいて [前へ] ボタンと移動先の表示を基にします。

注意

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

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

適用対象

こちらもご覧ください