Wizard 类 (System.Web.UI.WebControls)

全部折叠

语言筛选器

此页面仅适用于

Microsoft Visual Studio 2005/.NET Framework 2.0

同时提供下列产品的其他版本：

.NET Framework 类库

Wizard 类

注意：此类在 .NET Framework 2.0 版中是新增的。

提供导航和用户界面 (UI)，以跨多个步骤收集相关数据。

命名空间:System.Web.UI.WebControls
程序集:System.Web（在 system.web.dll 中）

语法

Visual Basic（声明）

<BindableAttribute(False)> _
Public Class Wizard
    Inherits CompositeControl

Visual Basic（用法）

Dim instance As Wizard

[BindableAttribute(false)] 
public class Wizard : CompositeControl

C++

[BindableAttribute(false)] 
public ref class Wizard : public CompositeControl

/** @attribute BindableAttribute(false) */ 
public class Wizard extends CompositeControl

JScript

BindableAttribute(false) 
public class Wizard extends CompositeControl

备注

可以使用 Wizard 控件执行下列操作：

跨多个步骤收集相关数据。
将用于收集用户输入的较大的网页细分为较小的逻辑步骤。
允许在各步骤之间进行线性导航或非线性导航。

Wizard 控件由以下部分组成：

一个由步骤组成的 T:System.Web.UI.WebControls.WizardStepCollection 集合，其中包含页面开发人员所定义的每个步骤的用户界面。
内置导航功能，基于 StepType 值确定要显示的相应按钮。
一个标题区域，用户可以自定义该区域，以显示用户当前所处步骤的特定信息。
一个侧栏区域，用于快速定位到控件中的步骤。

Wizard 控件中的每个步骤都具有一个 StepType 属性，用于确定该步骤所具有的导航功能的类型。如果没有为 StepType 属性指定值，则默认值为 Auto。下表列出了 StepType 属性的可用设置以及步骤的结果行为。

WizardStepType.Auto

为该步骤呈现的导航用户界面是由声明该步骤的顺序决定的。

WizardStepType.Complete

该步骤是要显示的最后一个步骤。不呈现任何导航按钮。

WizardStepType.Finish

该步骤是收集用户数据的最后一个步骤。呈现用于导航的“完成”按钮。

WizardStepType.Start

该步骤是要显示的第一个步骤。不呈现“上一步”按钮。

WizardStepType.Step

该步骤是介于第一个步骤和最后一个步骤之间的任意步骤。呈现用于导航的“上一步”和“下一步”按钮。

使用 Wizard 控件，可以通过线性导航或非线性导航收集数据。跳过不需要的步骤或返回前面已完成的步骤以更改某个值，这种行为就属于非线性导航。Wizard 控件维持它在各步骤之间的状态，以便在 Wizard 控件的所有步骤完成之前，无需将某个步骤中输入的数据保存到数据存储区中。

或者，如果希望在每个步骤完成（例如在引发 NextButtonClick 事件）后将已收集的数据保存到数据存储区，则应该将 WizardStepBase 对象的 AllowReturn 属性设置为 false，这样用户在提交数据后，将无法返回到前面已经完成的步骤来更改数据。

您可以使用 MoveTo 方法或 ActiveStepIndex 属性动态更改当前显示在 Wizard 控件中的步骤。

注意
如果在 Page_Load 事件处理程序中以编程方式添加 WizardStep，您必须在加载页之前将导航添加到该步骤中。

通过模板、外观和样式设置，可以完全自定义 Wizard 控件的外观。例如，您可以使用 HeaderTemplate、SideBarTemplate、StartNavigationTemplate、FinishNavigationTemplate 和 StepNavigationTemplate 属性自定义 Wizard 控件的界面。

注意
设置 FinishNavigationTemplate、DisplaySideBar、HeaderTemplate、SideBarTemplate、StartNavigationTemplate 或 StepNavigationTemplate 属性会重新创建 Wizard 控件的子控件。因此，子控件的视图状态会在处理过程中丢失。为了避免这种情况，请显式维护 Wizard 控件的子控件的控件状态，或者避免将控件置于模板中。

注意

设置 FinishNavigationTemplate、DisplaySideBar、HeaderTemplate、SideBarTemplate、StartNavigationTemplate 或 StepNavigationTemplate 属性会重新创建 Wizard 控件的子控件。因此，子控件的视图状态会在处理过程中丢失。为了避免这种情况，请显式维护 Wizard 控件的子控件的控件状态，或者避免将控件置于模板中。

注意，Wizard 控件不支持用于非标准模式或突发模式的特殊 Microsoft Internet Explorer 呈现。若要使用 Wizard 控件获取最佳的 Internet Explorer 呈现，请使用 XHTML 文档类型，Visual Web Developer 和 Visual Studio 中默认添加了该类型。

辅助功能

默认情况下，为此控件呈现的标记可能不符合辅助功能标准，例如 Web 内容辅助功能准则 1.0 (WCAG) 优先级 1 准则。例如，使用 CancelDestinationPageUrl 或 FinishDestinationPageUrl 将导致刷新页，这违背了单击页中的按钮或链接时不刷新页的辅助功能要求。有关此控件的辅助功能支持的详细信息，请参见 ASP.NET 控件和辅助功能。

Topic	Location
如何：自定义 ASP.NET CreateUserWizard 控件	生成 ASP .NET Web 应用程序
如何：自定义 ASP.NET CreateUserWizard 控件	在 Visual Studio 中生成 ASP .NET Web 应用程序
演练：ASP.NET Wizard 控件的高级用法	在 Visual Studio 中构建 ASP .NET Web 应用程序
演练：ASP.NET Wizard 控件的高级用法	在 Visual Studio 中生成 ASP .NET Web 应用程序
演练：创建基本的 ASP.NET Wizard 控件	在 Visual Studio 中构建 ASP .NET Web 应用程序
演练：创建基本的 ASP.NET Wizard 控件	在 Visual Studio 中生成 ASP .NET Web 应用程序

示例

下面的代码示例演示如何定义收集用户姓名和地址的 Wizard 控件，同时还可以选择输入单独的发货地址。如果用户没有选择“SeparateShippingCheckBox”，就会发出一个要求添加单独的发货地址的请求，而且 Wizard 控件直接从 Step2 转到 Finish。在 Finish 步骤中，用户可以选择单击“GoBackButton”返回到 Wizard 控件的开始处；但是，因为 Step1 的 AllowReturn 属性设置为 false，用户只能返回到 Step2。

Visual Basic

<%@ Page Language="VB" AutoEventWireup="false" CodeFile="WizardClass.vb" Inherits="WizardClassvb_aspx" %>

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

<html  >
  <body>
    <form id="form1" runat="server">    
      <asp:Wizard id="Wizard1" 
        runat="server" 
        onfinishbuttonclick="OnFinishButtonClick" 
        backcolor="#EFF3FB" 
        font-names="Verdana" 
        font-size="0.8em"
        borderwidth="1px" 
        bordercolor="#B5C7DE" 
        style="font-size: medium; font-family: Verdana;" 
        onactivestepchanged="OnActiveStepChanged">       
      <StepStyle forecolor="#333333" 
        font-size="0.8em" />
        <WizardSteps>        
          <asp:WizardStep id="Step1" 
            title="One"
            allowreturn="false" 
            runat="server" >
            Welcome to the Wizard example.  This step's AllowReturn property is set 
            to false, so after you leave this step you will not be able to return to it.
          </asp:WizardStep>          
          <asp:WizardStep id="Step2"
            title="Two" 
            runat="server" >
            <!-- ... Put UI elements here ... -->
            Please enter your billing information.
            <br />
            Name:<br />
            <asp:TextBox runat="server" 
              id="BillingName" 
              width="226px" 
              height="17px" /> 
            <br />
            Email Address:<br />
            <asp:TextBox runat="server" 
              id="EmailAddress" 
              width="224px" 
              height="17px" />
            <br />
            Address Line 1: <br />
            <asp:TextBox runat="server" 
              id="BillingAddressLine1" 
              width="314px" 
              height="17px" />
            <br />
            Address Line 2: <br />
            <asp:TextBox runat="server" 
              id="BillingAddressLine2" 
              width="314px" 
              height="17px" />
            <br />
            City: <br />
            <asp:TextBox runat="server" 
              id="BillingCity" 
              width="155px" 
              height="17px" /> 
            <br />
            State: <br />
            <asp:TextBox runat="server" 
              id="BillingState" 
              width="75px" 
              height="17px" /> 
            <br />
            ZIP Code: <br />
            <asp:TextBox runat="server" 
              id="BillingZip" 
              height="17px" />
            <br /><br />
            <asp:CheckBox runat="server" 
              id="SeparateShippingCheckBox" 
              text="Please check here if you would like to add a separate shipping address." />
          </asp:WizardStep>          
          <asp:WizardStep id="Step3" 
            title="Three"
            runat="server" >
            <!-- Gather the shipping address in this step if CheckBox1 was selected. -->
            Please enter your shipping information.
            <br />
                Name:<br />
                <asp:TextBox runat="server" 
                  id="ShippingName" 
                  height="17px" /> 
                <br />
                Address Line 1: <br />
                <asp:TextBox runat="server" 
                  id="ShippingAddress1" 
                  width="370px" 
                  height="17px" />
                <br />
                Address Line 2: <br />
                <asp:TextBox runat="server" 
                  id="ShippingAddress2" 
                  width="370px" 
                  height="17px" />
                <br />
                City: <br />
                <asp:TextBox runat="server" 
                  id="ShippingCity" 
                  height="17px" /> 
                <br />
                State: <br />
                <asp:TextBox runat="server" 
                  id="ShippingState" 
                  width="65px" 
                  height="17px" />
                <br /> 
                ZIP Code: <br />
                <asp:TextBox runat="server" 
                  id="ShippingZip" 
                  height="17px" />
          </asp:WizardStep>
          <asp:WizardStep id="Finish" 
            title="Finish"
            runat="server" >
            <!-- Put UI elements here for the Finish step. -->
            <asp:Button runat="server" 
              id="GoBackButton" 
              text="Go Back to Step 2" 
              forecolor="#284E98" 
              font-names="Verdana"
              font-size="1.0em" 
              borderstyle="Solid" 
              borderwidth="1px" 
              bordercolor="#507CD1" 
              backcolor="White" /> 
          </asp:WizardStep>          
          <asp:WizardStep runat="server" 
            steptype="Complete" 
            title="Complete" 
            id="Complete">
            <asp:Label runat="server" 
              id="CompleteMessageLabel" 
              width="408px" 
              height="24px">
            </asp:Label>
          </asp:WizardStep>
        </WizardSteps> 
        <NavigationButtonStyle forecolor="#284E98" 
          font-names="Verdana"
          font-size="1.0em" 
          borderstyle="Solid" 
          borderwidth="1px" 
          bordercolor="#507CD1" 
          backcolor="White" />
        <HeaderStyle forecolor="White" 
          horizontalalign="Center" 
          font-size="0.9em" 
          font-bold="True"
          backcolor="#284E98" 
          borderstyle="Solid" 
          bordercolor="#EFF3FB" 
          borderwidth="2px" />
        <SideBarStyle verticalalign="Top" 
          horizontalalign="Center"
          font-size="0.8em" 
          forecolor="#000099"
          backcolor="#EFF3FB"
          width="45px" />
        <HeaderTemplate>
          <b>Wizard Example</b>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

<%@ Page Language="C#" CodeFile="WizardClass.cs" Inherits="WizardClasscs_aspx" %>

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

<html  >
  <body>
    <form id="form1" runat="server">    
      <asp:Wizard id="Wizard1" 
        runat="server" 
        onfinishbuttonclick="OnFinishButtonClick" 
        backcolor="#EFF3FB" 
        font-names="Verdana" 
        font-size="0.8em"
        borderwidth="1px" 
        bordercolor="#B5C7DE" 
        style="font-size: medium; font-family: Verdana;" 
        onactivestepchanged="OnActiveStepChanged">       
      <StepStyle forecolor="#333333" 
        font-size="0.8em" />
        <WizardSteps>        
          <asp:WizardStep id="Step1" 
            title="One"
            allowreturn="false" 
            runat="server" >
            Welcome to the Wizard example.  This step's AllowReturn property is set 
            to false, so after you leave this step you will not be able to return to it.
          </asp:WizardStep>          
          <asp:WizardStep id="Step2"
            title="Two" 
            runat="server" >
            <!-- ... Put UI elements here ... -->
            Please enter your billing information.
            <br />
            Name:<br />
            <asp:TextBox runat="server" 
              id="BillingName" 
              width="226px" 
              height="17px" /> 
            <br />
            E-mail Address:<br />
            <asp:TextBox runat="server" 
              id="EmailAddress" 
              width="224px" 
              height="17px" />
            <br />
            Address Line 1: <br />
            <asp:TextBox runat="server" 
              id="BillingAddressLine1" 
              width="314px" 
              height="17px" />
            <br />
            Address Line 2: <br />
            <asp:TextBox runat="server" 
              id="BillingAddressLine2" 
              width="314px" 
              height="17px" />
            <br />
            City: <br />
            <asp:TextBox runat="server" 
              id="BillingCity" 
              width="155px" 
              height="17px" /> 
            <br />
            State: <br />
            <asp:TextBox runat="server" 
              id="BillingState" 
              width="75px" 
              height="17px" /> 
            <br />
            ZIP Code: <br />
            <asp:TextBox runat="server" 
              id="BillingZip" 
              height="17px" />
            <br /><br />
            <asp:CheckBox runat="server" 
              id="SeparateShippingCheckBox" 
              text="Please check here if you would like to add a separate shipping address." />
          </asp:WizardStep>          
          <asp:WizardStep id="Step3" 
            title="Three" 
            runat="server" >
            <!-- Gather the shipping address in this step if CheckBox1 was selected. -->
            Please enter your shipping information.
            <br />
                Name:<br />
                <asp:TextBox runat="server" 
                  id="ShippingName" 
                  height="17px" /> 
                <br />
                Address Line 1: <br />
                <asp:TextBox runat="server" 
                  id="ShippingAddress1" 
                  width="370px" 
                  height="17px" />
                <br />
                Address Line 2: <br />
                <asp:TextBox runat="server" 
                  id="ShippingAddress2" 
                  width="370px" 
                  height="17px" />
                <br />
                City: <br />
                <asp:TextBox runat="server" 
                  id="ShippingCity" 
                  height="17px" /> 
                <br />
                State: <br />
                <asp:TextBox runat="server" 
                  id="ShippingState" 
                  width="65px" 
                  height="17px" />
                <br /> 
                ZIP Code: <br />
                <asp:TextBox runat="server" 
                  id="ShippingZip" 
                  height="17px" />
          </asp:WizardStep>
          <asp:WizardStep id="Finish" 
            title="Finish"
            runat="server" >
            <!-- Put UI elements here for the Finish step. -->
            <asp:Button runat="server" 
              id="GoBackButton" 
              text="Go Back to Step 2" 
              onclick="OnGoBackButtonClick"
              forecolor="#284E98" 
              font-names="Verdana"
              font-size="1.0em" 
              borderstyle="Solid" 
              borderwidth="1px" 
              bordercolor="#507CD1" 
              backcolor="White" /> 
          </asp:WizardStep>          
          <asp:WizardStep runat="server" 
            steptype="Complete" 
            title="Complete" 
            id="Complete">
            <asp:Label runat="server" 
              id="CompleteMessageLabel" 
              width="408px" 
              height="24px">
            </asp:Label>
          </asp:WizardStep>
        </WizardSteps> 
        <NavigationButtonStyle forecolor="#284E98" 
          font-names="Verdana"
          font-size="1.0em" 
          borderstyle="Solid" 
          borderwidth="1px" 
          bordercolor="#507CD1" 
          backcolor="White" />
        <HeaderStyle forecolor="White" 
          horizontalalign="Center" 
          font-size="0.9em" 
          font-bold="True"
          backcolor="#284E98" 
          borderstyle="Solid" 
          bordercolor="#EFF3FB" 
          borderwidth="2px" />
        <SideBarStyle verticalalign="Top" 
          horizontalalign="Center"
          font-size="0.8em" 
          forecolor="#000099"
          backcolor="#EFF3FB"
          width="45px" />
        <HeaderTemplate>
          <b>Wizard Example</b>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

下面的代码示例是前面示例中使用的网页的代码隐藏文件。

Visual Basic

Partial Class WizardClassvb_aspx
    Inherits System.Web.UI.Page

   Protected Sub OnFinishButtonClick(ByVal sender As Object, ByVal e As WizardNavigationEventArgs) Handles Wizard1.FinishButtonClick

        ' The OnFinishButtonClick method is a good place to collect all
        ' the data from the completed pages and persist it to the data store. 

        ' For this example, write a confirmation message to the Complete page
        ' of the Wizard control.
        Dim tempLabel As Label = CType(Wizard1.FindControl("CompleteMessageLabel"), Label)
        If Not tempLabel Is Nothing Then

            Dim tempEmailAddress As String = "your e-mail address"
            If EmailAddress.Text.Length <> 0 Then
                tempEmailAddress = EmailAddress.Text
            End If

            tempLabel.Text = "Your order has been placed. An e-mail confirmation will be sent to " & _
                tempEmailAddress & "."

        End If
    End Sub

    Protected Sub OnGoBackButtonClick(ByVal sender As Object, ByVal e As EventArgs) Handles GoBackButton.Click

        ' The GoBackButtonClick event is raised when the GoBackButton
        ' is clicked on the Finish page of the Wizard.  

        ' Check the value of Step1's AllowReturn property.
        If Step1.AllowReturn Then
            ' Return to Step1.
            Wizard1.ActiveStepIndex = Wizard1.WizardSteps.IndexOf(Me.Step1)
        Else
            ' Step1 is not a valid step to return to; go to Step2 instead.
            Wizard1.ActiveStepIndex = Wizard1.WizardSteps.IndexOf(Me.Step2)
            Response.Write("ActiveStep is set to Step2 because Step1 has AllowReturn set to false.")
        End If
    End Sub

    Protected Sub OnActiveStepChanged(ByVal sender As Object, ByVal e As EventArgs) Handles Wizard1.ActiveStepChanged

        ' If the ActiveStep is changing to Step3, check to see whether the 
        ' SeparateShippingCheckBox is selected.  If it is not, skip to the
        ' Finish step.

        If (Wizard1.ActiveStepIndex = Wizard1.WizardSteps.IndexOf(Me.Step3)) Then

            If (Me.SeparateShippingCheckBox.Checked) Then
                Wizard1.MoveTo(Me.Step3)
            Else
                Wizard1.MoveTo(Me.Finish)
            End If

        End If
    End Sub

End Class

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class WizardClasscs_aspx : System.Web.UI.Page
{
    protected void OnFinishButtonClick(Object sender, WizardNavigationEventArgs e)
    {
        // The OnFinishButtonClick method is a good place to collect all
        // the data from the completed pages and persist it to the data store. 

        // For this example, write a confirmation message to the Complete page
        // of the Wizard control.
        Label tempLabel = (Label)Wizard1.FindControl("CompleteMessageLabel");
        if (tempLabel != null)
        {
            tempLabel.Text = "Your order has been placed. An e-mail confirmation will be sent to "
            + (EmailAddress.Text.Length == 0 ? "your e-mail address" : EmailAddress.Text) + ".";
        }
    }

    protected void OnGoBackButtonClick(object sender, EventArgs e)
    {
        // The GoBackButtonClick event is raised when the GoBackButton
        // is clicked on the Finish page of the Wizard.  

        // Check the value of Step1's AllowReturn property.
        if (Step1.AllowReturn)
        {
            // Return to Step1.
            Wizard1.ActiveStepIndex = Wizard1.WizardSteps.IndexOf(this.Step1);
        }
        else
        {
            // Step1 is not a valid step to return to; go to Step2 instead.
            Wizard1.ActiveStepIndex = Wizard1.WizardSteps.IndexOf(this.Step2);
            Response.Write("ActiveStep is set to Step2 because Step1 has AllowReturn set to false.");
        }
    }

    protected void OnActiveStepChanged(object sender, EventArgs e)
    {
        // If the ActiveStep is changing to Step3, check to see whether the 
        // SeparateShippingCheckBox is selected.  If it is not, skip to the
        // Finish step.
        if (Wizard1.ActiveStepIndex == Wizard1.WizardSteps.IndexOf(this.Step3))
        {
            if (this.SeparateShippingCheckBox.Checked)
            {
                Wizard1.MoveTo(this.Step3);
            }
            else
            {
                Wizard1.MoveTo(this.Finish);
            }
        }
    }
}

.NET Framework 安全性

AspNetHostingPermission 用于在宿主环境中进行操作。要求值：LinkDemand；权限值：Minimal。
AspNetHostingPermission 用于在宿主环境中进行操作。要求值：InheritanceDemand；权限值：Minimal。

继承层次结构

System.Object
   System.Web.UI.Control
     System.Web.UI.WebControls.WebControl
       System.Web.UI.WebControls.CompositeControl
        System.Web.UI.WebControls.Wizard
           System.Web.UI.WebControls.CreateUserWizard

线程安全

此类型的任何公共静态（Visual Basic 中的 Shared）成员都是线程安全的，但不保证所有实例成员都是线程安全的。

平台

Windows 98、Windows 2000 SP4、Windows Server 2003、Windows XP Media Center Edition、Windows XP Professional x64 Edition、Windows XP SP2、Windows XP Starter Edition

.NET Framework 并不是对每个平台的所有版本都提供支持。有关受支持版本的列表，请参见系统要求。

版本信息

.NET Framework

受以下版本支持：2.0

请参见

参考

Wizard 成员
System.Web.UI.WebControls 命名空间
CompositeControl 类
Control

其他资源

Wizard Web 服务器控件
Wizard Web 服务器控件概述

标记

: 添加标记

社区内容

添加新内容

批注

个人信息中心 | 法律信息 | MSDN Flash 中心 | 联系我们