Wizard Wizard Wizard Wizard Class

Definition

Provides navigation and a user interface (UI) to collect related data across multiple steps.

public ref class Wizard : System::Web::UI::WebControls::CompositeControl
[System.ComponentModel.Bindable(false)]
public class Wizard : System.Web.UI.WebControls.CompositeControl
type Wizard = class
    inherit CompositeControl
Public Class Wizard
Inherits CompositeControl
Inheritance
Derived
Attributes

Examples

The following code example demonstrates how to define a Wizard control to collect a user's name and address, with the option to enter a separate shipping address. If the user does not select SeparateShippingCheckBox, thereby issuing a request to add a separate shipping address, the Wizard control moves directly from Step2 to Finish. On the Finish step, the user has the option to return to the beginning of the Wizard control by clicking GoBackButton; however, it takes the user to Step2 because the AllowReturn property for Step1 is set to false.

Important

This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

<%@ 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 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" 
        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" 
              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>
<%@ 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 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" 
        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>

The following code example is the code-behind file for the Web page used in the preceding example.

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 email confirmation will be sent to "
            + (EmailAddress.Text.Length == 0 ? "your email 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);
            }
        }
    }
}
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 email address"
            If EmailAddress.Text.Length <> 0 Then
                tempEmailAddress = EmailAddress.Text
            End If

            tempLabel.Text = "Your order has been placed. An email 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

Remarks

In this topic:

Introduction

You can use the Wizard control to:

  • Collect related data across multiple steps.

  • Break up a larger Web page used to collect user input into smaller logical steps.

  • Allow for either linear or nonlinear navigation through the steps.

Wizard Components

The Wizard control is made up of the following components:

  • A WizardStepCollection collection of steps that contain the user interface for each step, as defined by the page developer.

  • Built-in navigation capabilities that determine the appropriate buttons to display based on the StepType value.

  • A header area that can be customized to display information specific to the step that the user is currently on.

  • A sidebar area that can be used to quickly navigate to steps in the control.

    Note

    If you are using Microsoft Visual Studio 2005, note that the ActiveStepIndex is persisted in Source view. If you change the WizardSteps property in Design view by clicking the sidebar buttons, and you then run the page, the first step of the Wizard control might not be shown because the ActiveStepIndex might be pointing to a different step.

Wizard Steps

Each of the steps in the Wizard control has a StepType property that determines the kind of navigation functionality that the step has. If you do not specify a value for the StepType property, the default value is Auto. The following table lists the available settings for the StepType property and the resulting behavior of the step.

WizardStepType.Auto
The navigation UI that is rendered for the step is determined by the order in which the step is declared.

WizardStepType.Complete
The step is the last one to appear. No navigation buttons are rendered.

WizardStepType.Finish
The step is the last one that collects user data. The Finish button is rendered for navigation.

WizardStepType.Start
The step is the first one to appear. A Previous button is not rendered.

WizardStepType.Step
The step is any step between the first and last. Previous and Next buttons are rendered for navigation.

Collecting Wizard Data

Using the Wizard control, data can be collected through linear or nonlinear navigation. Some examples of nonlinear navigation are skipping unnecessary steps or returning to a previously completed step to change some value. The Wizard control maintains its state between steps, so the data entered on a step does not need to be persisted to a data store until all the steps of the Wizard control have been completed.

Alternatively, if you want to persist the collected data to a data store as each step is completed, such as when the NextButtonClick event is raised, you should set the AllowReturn property of the WizardStepBase object to false so that the user cannot return to a previously completed step and change the data once it has been submitted.

Wizard Command Names

The Wizard control inherits the following command names from the View class and MultiView class: NextViewCommandName, PreviousViewCommandName, SwitchViewByIDCommandName, and SwitchViewByIndexCommandName. The Wizard control ignores these command names and does not include any special logic to enable these commands to automatically work for navigation. If a command name is removed or is missing from a button in the Wizard control, no exception is thrown. For example, if the StartNavigationTemplate button is missing a value for CommandName, no exception is thrown.

Dynamically Changing Steps

You can use the MoveTo method or the ActiveStepIndex property to dynamically change the step that is currently displayed in the Wizard control.

Note

If you programmatically add a WizardStep in the Page_Load event handler, you must add the navigation to that step prior to the page loading.

Wizard Appearance

The appearance of the Wizard control is fully customizable through templates, skins, and style settings. For example, you can use the HeaderTemplate, SideBarTemplate, StartNavigationTemplate, FinishNavigationTemplate, and StepNavigationTemplate properties to customize the interface of the Wizard control.

Note

Setting the FinishNavigationTemplate, DisplaySideBar, HeaderTemplate, SideBarTemplate, StartNavigationTemplate, or StepNavigationTemplate property recreates the child controls of the Wizard control. As a result, the view state for the child controls is lost in the process. To avoid this situation, explicitly maintain the control state of the Wizard control's child controls explicitly, or avoid putting controls inside of templates.

Note that the Wizard control does not support special Microsoft Internet Explorer rendering for non-standard or quirks mode. To get the best Internet Explorer rendering using the Wizard control, use the XHTML doc type, which is added by default in Visual Web Developer and Visual Studio.

Formatting Using Layout Templates

The Wizard control lets you specify the layout of the control without requiring you to use an HTML table element. Instead, you can use a LayoutTemplate element to specify the layout. In the template, you create placeholder controls to indicate where items should be dynamically inserted into the control. (This is similar to how the template model for the ListView control works.) For more information, see the Wizard.LayoutTemplate property.

Accessibility

For information about how to configure this control so that it generates markup that conforms to accessibility standards, see Accessibility in Visual Studio and ASP.NET and ASP.NET Controls and Accessibility.

Declarative Syntax

<asp:Wizard  
    AccessKey="string"  
    ActiveStepIndex="integer"  
    BackColor="color name|#dddddd"  
    BorderColor="color name|#dddddd"  
    BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|  
        Inset|Outset"  
    BorderWidth="size"  
    CancelButtonImageUrl="uri"  
    CancelButtonText="string"  
    CancelButtonType="Button|Image|Link"  
    CancelDestinationPageUrl="uri"  
    CellPadding="integer"  
    CellSpacing="integer"  
    CssClass="string"  
    DisplayCancelButton="True|False"  
    DisplaySideBar="True|False"  
    Enabled="True|False"  
    EnableTheming="True|False"  
    EnableViewState="True|False"  
    FinishCompleteButtonImageUrl="uri"  
    FinishCompleteButtonText="string"  
    FinishCompleteButtonType="Button|Image|Link"  
    FinishDestinationPageUrl="uri"  
    FinishPreviousButtonImageUrl="uri"  
    FinishPreviousButtonText="string"  
    FinishPreviousButtonType="Button|Image|Link"  
    Font-Bold="True|False"  
    Font-Italic="True|False"  
    Font-Names="string"  
    Font-Overline="True|False"  
    Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|  
        Large|X-Large|XX-Large"  
    Font-Strikeout="True|False"  
    Font-Underline="True|False"  
    ForeColor="color name|#dddddd"  
    HeaderText="string"  
    Height="size"  
    ID="string"  
    OnActiveStepChanged="ActiveStepChanged event handler"  
    OnCancelButtonClick="CancelButtonClick event handler"  
    OnDataBinding="DataBinding event handler"  
    OnDisposed="Disposed event handler"  
    OnFinishButtonClick="FinishButtonClick event handler"  
    OnInit="Init event handler"  
    OnLoad="Load event handler"  
    OnNextButtonClick="NextButtonClick event handler"  
    OnPreRender="PreRender event handler"  
    OnPreviousButtonClick="PreviousButtonClick event handler"  
    OnSideBarButtonClick="SideBarButtonClick event handler"  
    OnUnload="Unload event handler"  
    runat="server"  
    SkinID="string"  
    SkipLinkText="string"  
    StartNextButtonImageUrl="uri"  
    StartNextButtonText="string"  
    StartNextButtonType="Button|Image|Link"  
    StepNextButtonImageUrl="uri"  
    StepNextButtonText="string"  
    StepNextButtonType="Button|Image|Link"  
    StepPreviousButtonImageUrl="uri"  
    StepPreviousButtonText="string"  
    StepPreviousButtonType="Button|Image|Link"  
    Style="string"  
    TabIndex="integer"  
    ToolTip="string"  
    Visible="True|False"  
    Width="size"  
>  
        <CancelButtonStyle />  
        <FinishCompleteButtonStyle />  
        <FinishNavigationTemplate>  
            <!-- child controls -->  
        </FinishNavigationTemplate>  
        <FinishPreviousButtonStyle />  
        <HeaderStyle />  
        <HeaderTemplate>  
            <!-- child controls -->  
        </HeaderTemplate>  
        <NavigationButtonStyle />  
        <NavigationStyle />  
        <SideBarButtonStyle />  
        <SideBarStyle />  
        <SideBarTemplate>  
            <!-- child controls -->  
        </SideBarTemplate>  
        <StartNavigationTemplate>  
            <!-- child controls -->  
        </StartNavigationTemplate>  
        <StartNextButtonStyle />  
        <StepNavigationTemplate>  
            <!-- child controls -->  
        </StepNavigationTemplate>  
        <StepNextButtonStyle />  
        <StepPreviousButtonStyle />  
        <StepStyle />  
        <WizardSteps>  
                <asp:TemplatedWizardStep  
                    AllowReturn="True|False"  
                    ContentTemplateContainer="string"  
                    EnableTheming="True|False"  
                    EnableViewState="True|False"  
                    ID="string"  
                    OnActivate="Activate event handler"  
                    OnDataBinding="DataBinding event handler"  
                    OnDeactivate="Deactivate event handler"  
                    OnDisposed="Disposed event handler"  
                    OnInit="Init event handler"  
                    OnLoad="Load event handler"  
                    OnPreRender="PreRender event handler"  
                    OnUnload="Unload event handler"  
                    runat="server"  
                    SkinID="string"  
                    StepType="Auto|Complete|Finish|Start|Step"  
                    Title="string"  
                    Visible="True|False"  
>  
                        <ContentTemplate>  
                            <!-- child controls -->  
                        </ContentTemplate>  
                        <CustomNavigationTemplate>  
                            <!-- child controls -->  
                        </CustomNavigationTemplate>  
                </asp:TemplatedWizardStep>  
                <asp:WizardStep  
                    AllowReturn="True|False"  
                    EnableTheming="True|False"  
                    EnableViewState="True|False"  
                    ID="string"  
                    OnActivate="Activate event handler"  
                    OnDataBinding="DataBinding event handler"  
                    OnDeactivate="Deactivate event handler"  
                    OnDisposed="Disposed event handler"  
                    OnInit="Init event handler"  
                    OnLoad="Load event handler"  
                    OnPreRender="PreRender event handler"  
                    OnUnload="Unload event handler"  
                    runat="server"  
                    SkinID="string"  
                    StepType="Auto|Complete|Finish|Start|Step"  
                    Title="string"  
                    Visible="True|False"  
                />  
        </WizardSteps>  
</asp:Wizard>  

Constructors

Wizard() Wizard() Wizard() Wizard()

Initializes a new instance of the Wizard class.

Fields

CancelButtonID CancelButtonID CancelButtonID CancelButtonID

Specifies the identifier for the Cancel button. This field is static and read-only.

CancelCommandName CancelCommandName CancelCommandName CancelCommandName

Retrieves the command name for the Cancel button. This field is static and read-only.

CustomFinishButtonID CustomFinishButtonID CustomFinishButtonID CustomFinishButtonID

Retrieves the identifier for a custom Finish button. This field is static and read-only.

CustomNextButtonID CustomNextButtonID CustomNextButtonID CustomNextButtonID

Retrieves the identifier for a custom Next button. This field is static and read-only.

CustomPreviousButtonID CustomPreviousButtonID CustomPreviousButtonID CustomPreviousButtonID

Retrieves the identifier for a custom Previous button. This field is static and read-only.

DataListID DataListID DataListID DataListID

Retrieves the identifier for the sidebar DataList collection. This field is static and read-only.

FinishButtonID FinishButtonID FinishButtonID FinishButtonID

Retrieves the identifier for the Finish button. This field is static and read-only.

FinishPreviousButtonID FinishPreviousButtonID FinishPreviousButtonID FinishPreviousButtonID

Retrieves the identifier for the Previous button on the Finish step. This field is static and read-only.

HeaderPlaceholderId HeaderPlaceholderId HeaderPlaceholderId HeaderPlaceholderId

Gets the ID of the HeaderTemplate placeholder in a Wizard control.

MoveCompleteCommandName MoveCompleteCommandName MoveCompleteCommandName MoveCompleteCommandName

Retrieves the command name that is associated with the Finish button. This field is static and read-only.

MoveNextCommandName MoveNextCommandName MoveNextCommandName MoveNextCommandName

Retrieves the command name that is associated with the Next button. This field is static and read-only.

MovePreviousCommandName MovePreviousCommandName MovePreviousCommandName MovePreviousCommandName

Retrieves the command name that is associated with the Previous button. This field is static and read-only.

MoveToCommandName MoveToCommandName MoveToCommandName MoveToCommandName

Retrieves the command name that is associated with each of the sidebar buttons. This field is static and read-only.

NavigationPlaceholderId NavigationPlaceholderId NavigationPlaceholderId NavigationPlaceholderId

Gets the ID of the StartNavigationTemplate placeholder in a Wizard control.

SideBarButtonID SideBarButtonID SideBarButtonID SideBarButtonID

Retrieves the identifier that is associated with each of the sidebar buttons. This field is static and read-only.

SideBarPlaceholderId SideBarPlaceholderId SideBarPlaceholderId SideBarPlaceholderId

Gets the ID of the SideBarTemplate placeholder in a Wizard control.

StartNextButtonID StartNextButtonID StartNextButtonID StartNextButtonID

Retrieves the identifier that is associated with the Next button on the Start step. This field is static and read-only.

StepNextButtonID StepNextButtonID StepNextButtonID StepNextButtonID

Retrieves the identifier that is associated with the Next button. This field is static and read-only.

StepPreviousButtonID StepPreviousButtonID StepPreviousButtonID StepPreviousButtonID

Retrieves the identifier that is associated with the Previous button. This field is static and read-only.

WizardStepPlaceholderId WizardStepPlaceholderId WizardStepPlaceholderId WizardStepPlaceholderId

Gets the ID of the WizardStep placeholder in a Wizard control.

Properties

AccessKey AccessKey AccessKey AccessKey

Gets or sets the access key that allows you to quickly navigate to the Web server control.

(Inherited from WebControl)
ActiveStep ActiveStep ActiveStep ActiveStep

Gets the step in the WizardSteps collection that is currently displayed to the user.

ActiveStepIndex ActiveStepIndex ActiveStepIndex ActiveStepIndex

Gets or sets the index of the current WizardStepBase object.

Adapter Adapter Adapter Adapter

Gets the browser-specific adapter for the control.

(Inherited from Control)
AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory

Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.

(Inherited from Control)
Attributes Attributes Attributes Attributes

Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.

(Inherited from WebControl)
BackColor BackColor BackColor BackColor

Gets or sets the background color of the Web server control.

(Inherited from WebControl)
BindingContainer BindingContainer BindingContainer BindingContainer

Gets the control that contains this control's data binding.

(Inherited from Control)
BorderColor BorderColor BorderColor BorderColor

Gets or sets the border color of the Web control.

(Inherited from WebControl)
BorderStyle BorderStyle BorderStyle BorderStyle

Gets or sets the border style of the Web server control.

(Inherited from WebControl)
BorderWidth BorderWidth BorderWidth BorderWidth

Gets or sets the border width of the Web server control.

(Inherited from WebControl)
CancelButtonImageUrl CancelButtonImageUrl CancelButtonImageUrl CancelButtonImageUrl

Gets or sets the URL of the image displayed for the Cancel button.

CancelButtonStyle CancelButtonStyle CancelButtonStyle CancelButtonStyle

Gets a reference to a collection of style properties that define the appearance of the Cancel button.

CancelButtonText CancelButtonText CancelButtonText CancelButtonText

Gets or sets the text caption that is displayed for the Cancel button.

CancelButtonType CancelButtonType CancelButtonType CancelButtonType

Gets or sets the type of button that is rendered as the Cancel button.

CancelDestinationPageUrl CancelDestinationPageUrl CancelDestinationPageUrl CancelDestinationPageUrl

Gets or sets the URL that the user is directed to when they click the Cancel button.

CellPadding CellPadding CellPadding CellPadding

Gets or sets the amount of space between the contents of the cell and the cell border.

CellSpacing CellSpacing CellSpacing CellSpacing

Gets or sets the amount of space between cells.

ChildControlsCreated ChildControlsCreated ChildControlsCreated ChildControlsCreated

Gets a value that indicates whether the server control's child controls have been created.

(Inherited from Control)
ClientID ClientID ClientID ClientID

Gets the control ID for HTML markup that is generated by ASP.NET.

(Inherited from Control)
ClientIDMode ClientIDMode ClientIDMode ClientIDMode

Gets or sets the algorithm that is used to generate the value of the ClientID property.

(Inherited from Control)
ClientIDSeparator ClientIDSeparator ClientIDSeparator ClientIDSeparator

Gets a character value representing the separator character used in the ClientID property.

(Inherited from Control)
Context Context Context Context

Gets the HttpContext object associated with the server control for the current Web request.

(Inherited from Control)
Controls Controls Controls Controls

Gets a ControlCollection object that represents the child controls in a CompositeControl.

(Inherited from CompositeControl)
ControlStyle ControlStyle ControlStyle ControlStyle

Gets the style of the Web server control. This property is used primarily by control developers.

(Inherited from WebControl)
ControlStyleCreated ControlStyleCreated ControlStyleCreated ControlStyleCreated

Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.

(Inherited from WebControl)
CssClass CssClass CssClass CssClass

Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.

(Inherited from WebControl)
DataItemContainer DataItemContainer DataItemContainer DataItemContainer

Gets a reference to the naming container if the naming container implements IDataItemContainer.

(Inherited from Control)
DataKeysContainer DataKeysContainer DataKeysContainer DataKeysContainer

Gets a reference to the naming container if the naming container implements IDataKeysControl.

(Inherited from Control)
DesignMode DesignMode DesignMode DesignMode

Gets a value indicating whether a control is being used on a design surface.

(Inherited from Control)
DisplayCancelButton DisplayCancelButton DisplayCancelButton DisplayCancelButton

Gets or sets a Boolean value indicating whether to display a Cancel button.

DisplaySideBar DisplaySideBar DisplaySideBar DisplaySideBar

Gets or sets a Boolean value indicating whether to display the sidebar area on the Wizard control.

Enabled Enabled Enabled Enabled

Gets or sets a value indicating whether the Web server control is enabled.

(Inherited from WebControl)
EnableTheming EnableTheming EnableTheming EnableTheming

Gets or sets a value indicating whether themes apply to this control.

(Inherited from WebControl)
EnableViewState EnableViewState EnableViewState EnableViewState

Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.

(Inherited from Control)
Events Events Events Events

Gets a list of event handler delegates for the control. This property is read-only.

(Inherited from Control)
FinishCompleteButtonImageUrl FinishCompleteButtonImageUrl FinishCompleteButtonImageUrl FinishCompleteButtonImageUrl

Gets or sets the URL of the image that is displayed for the Finish button.

FinishCompleteButtonStyle FinishCompleteButtonStyle FinishCompleteButtonStyle FinishCompleteButtonStyle

Gets a reference to a Style object that defines the settings for the Finish button.

FinishCompleteButtonText FinishCompleteButtonText FinishCompleteButtonText FinishCompleteButtonText

Gets or sets the text caption that is displayed for the Finish button.

FinishCompleteButtonType FinishCompleteButtonType FinishCompleteButtonType FinishCompleteButtonType

Gets or sets the type of button that is rendered as the Finish button.

FinishDestinationPageUrl FinishDestinationPageUrl FinishDestinationPageUrl FinishDestinationPageUrl

Gets or sets the URL that the user is redirected to when they click the Finish button.

FinishNavigationTemplate FinishNavigationTemplate FinishNavigationTemplate FinishNavigationTemplate

Gets or sets the template that is used to display the navigation area on the Finish step.

FinishPreviousButtonImageUrl FinishPreviousButtonImageUrl FinishPreviousButtonImageUrl FinishPreviousButtonImageUrl

Gets or sets the URL of the image that is displayed for the Previous button on the Finish step.

FinishPreviousButtonStyle FinishPreviousButtonStyle FinishPreviousButtonStyle FinishPreviousButtonStyle

Gets a reference to a Style object that defines the settings for the Previous button on the Finish step.

FinishPreviousButtonText FinishPreviousButtonText FinishPreviousButtonText FinishPreviousButtonText

Gets or sets the text caption that is displayed for the Previous button on the Finish step.

FinishPreviousButtonType FinishPreviousButtonType FinishPreviousButtonType FinishPreviousButtonType

Gets or sets the type of button that is rendered as the Previous button on the Finish step.

Font Font Font Font

Gets the font properties associated with the Web server control.

(Inherited from WebControl)
ForeColor ForeColor ForeColor ForeColor

Gets or sets the foreground color (typically the color of the text) of the Web server control.

(Inherited from WebControl)
HasAttributes HasAttributes HasAttributes HasAttributes

Gets a value indicating whether the control has attributes set.

(Inherited from WebControl)
HasChildViewState HasChildViewState HasChildViewState HasChildViewState

Gets a value indicating whether the current server control's child controls have any saved view-state settings.

(Inherited from Control)
HeaderStyle HeaderStyle HeaderStyle HeaderStyle

Gets a reference to a Style object that defines the settings for the header area on the control.

HeaderTemplate HeaderTemplate HeaderTemplate HeaderTemplate

Gets or sets the template that is used to display the header area on the control.

HeaderText HeaderText HeaderText HeaderText

Gets or sets the text caption that is displayed for the header area on the control.

Height Height Height Height

Gets or sets the height of the Web server control.

(Inherited from WebControl)
IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder

For a description of this member, see ControlBuilder.

(Inherited from Control)
IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData

For a description of this member, see UserData.

(Inherited from Control)
ID ID ID ID

Gets or sets the programmatic identifier assigned to the server control.

(Inherited from Control)
IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings

For a description of this member, see DataBindings.

(Inherited from Control)
IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings

For a description of this member, see HasDataBindings.

(Inherited from Control)
IdSeparator IdSeparator IdSeparator IdSeparator

Gets the character used to separate control identifiers.

(Inherited from Control)
IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions

For a description of this member, see Expressions.

(Inherited from Control)
IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions

For a description of this member, see HasExpressions.

(Inherited from Control)
IsChildControlStateCleared IsChildControlStateCleared IsChildControlStateCleared IsChildControlStateCleared

Gets a value indicating whether controls contained within this control have control state.

(Inherited from Control)
IsEnabled IsEnabled IsEnabled IsEnabled

Gets a value indicating whether the control is enabled.

(Inherited from WebControl)
IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

Gets a value that indicates whether the server control is saving changes to its view state.

(Inherited from Control)
IsViewStateEnabled IsViewStateEnabled IsViewStateEnabled IsViewStateEnabled

Gets a value indicating whether view state is enabled for this control.

(Inherited from Control)
LayoutTemplate LayoutTemplate LayoutTemplate LayoutTemplate

Gets or sets the custom content of the root container in a Wizard control.

LoadViewStateByID LoadViewStateByID LoadViewStateByID LoadViewStateByID

Gets a value indicating whether the control participates in loading its view state by ID instead of index.

(Inherited from Control)
NamingContainer NamingContainer NamingContainer NamingContainer

Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.

(Inherited from Control)
NavigationButtonStyle NavigationButtonStyle NavigationButtonStyle NavigationButtonStyle

Gets a reference to a Style object that defines the settings for the buttons in the navigation area on the control.

NavigationStyle NavigationStyle NavigationStyle NavigationStyle

Gets a reference to a Style object that defines the settings for the navigation area on the control.

Page Page Page Page

Gets a reference to the Page instance that contains the server control.

(Inherited from Control)
Parent Parent Parent Parent

Gets a reference to the server control's parent control in the page control hierarchy.

(Inherited from Control)
RenderingCompatibility RenderingCompatibility RenderingCompatibility RenderingCompatibility

Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.

(Inherited from Control)
SideBarButtonStyle SideBarButtonStyle SideBarButtonStyle SideBarButtonStyle

Gets a reference to a Style object that defines the settings for the buttons on the sidebar.

SideBarStyle SideBarStyle SideBarStyle SideBarStyle

Gets a reference to a Style object that defines the settings for the sidebar area on the control.

SideBarTemplate SideBarTemplate SideBarTemplate SideBarTemplate

Gets or sets the template that is used to display the sidebar area on the control.

Site Site Site Site

Gets information about the container that hosts the current control when rendered on a design surface.

(Inherited from Control)
SkinID SkinID SkinID SkinID

Gets or sets the skin to apply to the control.

(Inherited from WebControl)
SkipLinkText SkipLinkText SkipLinkText SkipLinkText

Gets or sets a value that is used to render alternate text that notifies screen readers to skip the content in the sidebar area.

StartNavigationTemplate StartNavigationTemplate StartNavigationTemplate StartNavigationTemplate

Gets or sets the template that is used to display the navigation area on the Start step of the Wizard control.

StartNextButtonImageUrl StartNextButtonImageUrl StartNextButtonImageUrl StartNextButtonImageUrl

Gets or sets the URL of the image that is displayed for the Next button on the Start step.

StartNextButtonStyle StartNextButtonStyle StartNextButtonStyle StartNextButtonStyle

Gets a reference to a Style object that defines the settings for the Next button on the Start step.

StartNextButtonText StartNextButtonText StartNextButtonText StartNextButtonText

Gets or sets the text caption that is displayed for the Next button on the Start step.

StartNextButtonType StartNextButtonType StartNextButtonType StartNextButtonType

Gets or sets the type of button that is rendered as the Next button on the Start step.

StepNavigationTemplate StepNavigationTemplate StepNavigationTemplate StepNavigationTemplate

Gets or sets the template that is used to display the navigation area on any WizardStepBase-derived objects other than the Start, the Finish, or Complete step.

StepNextButtonImageUrl StepNextButtonImageUrl StepNextButtonImageUrl StepNextButtonImageUrl

Gets or sets the URL of the image that is displayed for the Next button.

StepNextButtonStyle StepNextButtonStyle StepNextButtonStyle StepNextButtonStyle

Gets a reference to the Style object that defines the settings for the Next button.

StepNextButtonText StepNextButtonText StepNextButtonText StepNextButtonText

Gets or sets the text caption that is displayed for the Next button.

StepNextButtonType StepNextButtonType StepNextButtonType StepNextButtonType

Gets or sets the type of button that is rendered as the Next button.

StepPreviousButtonImageUrl StepPreviousButtonImageUrl StepPreviousButtonImageUrl StepPreviousButtonImageUrl

Gets or sets the URL of the image that is displayed for the Previous button.

StepPreviousButtonStyle StepPreviousButtonStyle StepPreviousButtonStyle StepPreviousButtonStyle

Gets a reference to a Style object that defines the settings for the Previous button.

StepPreviousButtonText StepPreviousButtonText StepPreviousButtonText StepPreviousButtonText

Gets or sets the text caption that is displayed for the Previous button.

StepPreviousButtonType StepPreviousButtonType StepPreviousButtonType StepPreviousButtonType

Gets or sets the type of button that is rendered as the Previous button.

StepStyle StepStyle StepStyle StepStyle

Gets a reference to a Style object that defines the settings for the WizardStep objects.

Style Style Style Style

Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.

(Inherited from WebControl)
SupportsDisabledAttribute SupportsDisabledAttribute SupportsDisabledAttribute SupportsDisabledAttribute

Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.

(Inherited from CompositeControl)
TabIndex TabIndex TabIndex TabIndex

Gets or sets the tab index of the Web server control.

(Inherited from WebControl)
TagKey TagKey TagKey TagKey

Gets the HtmlTextWriterTag value that corresponds to the Wizard control.

TagName TagName TagName TagName

Gets the name of the control tag. This property is used primarily by control developers.

(Inherited from WebControl)
TemplateControl TemplateControl TemplateControl TemplateControl

Gets or sets a reference to the template that contains this control.

(Inherited from Control)
TemplateSourceDirectory TemplateSourceDirectory TemplateSourceDirectory TemplateSourceDirectory

Gets the virtual directory of the Page or UserControl that contains the current server control.

(Inherited from Control)
ToolTip ToolTip ToolTip ToolTip

Gets or sets the text displayed when the mouse pointer hovers over the Web server control.

(Inherited from WebControl)
UniqueID UniqueID UniqueID UniqueID

Gets the unique, hierarchically qualified identifier for the server control.

(Inherited from Control)
ValidateRequestMode ValidateRequestMode ValidateRequestMode ValidateRequestMode

Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.

(Inherited from Control)
ViewState ViewState ViewState ViewState

Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.

(Inherited from Control)
ViewStateIgnoresCase ViewStateIgnoresCase ViewStateIgnoresCase ViewStateIgnoresCase

Gets a value that indicates whether the StateBag object is case-insensitive.

(Inherited from Control)
ViewStateMode ViewStateMode ViewStateMode ViewStateMode

Gets or sets the view-state mode of this control.

(Inherited from Control)
Visible Visible Visible Visible

Gets or sets a value that indicates whether a server control is rendered as UI on the page.

(Inherited from Control)
Width Width Width Width

Gets or sets the width of the Web server control.

(Inherited from WebControl)
WizardSteps WizardSteps WizardSteps WizardSteps

Gets a collection containing all the WizardStepBase objects that are defined for the control.

Methods

AddAttributesToRender(HtmlTextWriter) AddAttributesToRender(HtmlTextWriter) AddAttributesToRender(HtmlTextWriter) AddAttributesToRender(HtmlTextWriter)

Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.

(Inherited from WebControl)
AddedControl(Control, Int32) AddedControl(Control, Int32) AddedControl(Control, Int32) AddedControl(Control, Int32)

Called after a child control is added to the Controls collection of the Control object.

(Inherited from Control)
AddParsedSubObject(Object) AddParsedSubObject(Object) AddParsedSubObject(Object) AddParsedSubObject(Object)

Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.

(Inherited from Control)
AllowNavigationToStep(Int32) AllowNavigationToStep(Int32) AllowNavigationToStep(Int32) AllowNavigationToStep(Int32)

Uses a Boolean value to determine whether the ActiveStep property can be set to the WizardStepBase object that corresponds to the index that is passed in.

ApplyStyle(Style) ApplyStyle(Style) ApplyStyle(Style) ApplyStyle(Style)

Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.

(Inherited from WebControl)
ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page)

Applies the style properties defined in the page style sheet to the control.

(Inherited from Control)
BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object)

Begins design-time tracing of rendering data.

(Inherited from Control)
BuildProfileTree(String, Boolean) BuildProfileTree(String, Boolean) BuildProfileTree(String, Boolean) BuildProfileTree(String, Boolean)

Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.

(Inherited from Control)
ClearCachedClientID() ClearCachedClientID() ClearCachedClientID() ClearCachedClientID()

Sets the cached ClientID value to null.

(Inherited from Control)
ClearChildControlState() ClearChildControlState() ClearChildControlState() ClearChildControlState()

Deletes the control-state information for the server control's child controls.

(Inherited from Control)
ClearChildState() ClearChildState() ClearChildState() ClearChildState()

Deletes the view-state and control-state information for all the server control's child controls.

(Inherited from Control)
ClearChildViewState() ClearChildViewState() ClearChildViewState() ClearChildViewState()

Deletes the view-state information for all the server control's child controls.

(Inherited from Control)
ClearEffectiveClientIDMode() ClearEffectiveClientIDMode() ClearEffectiveClientIDMode() ClearEffectiveClientIDMode()

Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.

(Inherited from Control)
CopyBaseAttributes(WebControl) CopyBaseAttributes(WebControl) CopyBaseAttributes(WebControl) CopyBaseAttributes(WebControl)

Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.

(Inherited from WebControl)
CreateChildControls() CreateChildControls() CreateChildControls() CreateChildControls()

Creates child controls.

CreateControlCollection() CreateControlCollection() CreateControlCollection() CreateControlCollection()

Creates control collection.

CreateControlHierarchy() CreateControlHierarchy() CreateControlHierarchy() CreateControlHierarchy()

Creates the hierarchy of child controls that make up the control.

CreateControlStyle() CreateControlStyle() CreateControlStyle() CreateControlStyle()

Creates control style.

DataBind() DataBind() DataBind() DataBind()

Binds a data source to the CompositeControl and all its child controls.

(Inherited from CompositeControl)
DataBind(Boolean) DataBind(Boolean) DataBind(Boolean) DataBind(Boolean)

Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.

(Inherited from Control)
DataBindChildren() DataBindChildren() DataBindChildren() DataBindChildren()

Binds a data source to the server control's child controls.

(Inherited from Control)
Dispose() Dispose() Dispose() Dispose()

Enables a server control to perform final clean up before it is released from memory.

(Inherited from Control)
EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object)

Ends design-time tracing of rendering data.

(Inherited from Control)
EnsureChildControls() EnsureChildControls() EnsureChildControls() EnsureChildControls()

Determines whether the server control contains child controls. If it does not, it creates child controls.

(Inherited from Control)
EnsureID() EnsureID() EnsureID() EnsureID()

Creates an identifier for controls that do not have an identifier assigned.

(Inherited from Control)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindControl(String) FindControl(String) FindControl(String) FindControl(String)

Searches the current naming container for a server control with the specified id parameter.

(Inherited from Control)
FindControl(String, Int32) FindControl(String, Int32) FindControl(String, Int32) FindControl(String, Int32)

Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.

(Inherited from Control)
Focus() Focus() Focus() Focus()

Sets input focus to a control.

(Inherited from Control)
GetDesignModeState() GetDesignModeState() GetDesignModeState() GetDesignModeState()

Gets the design mode state.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetHistory() GetHistory() GetHistory() GetHistory()

Returns a collection of WizardStepBase objects that have been accessed.

GetRouteUrl(Object) GetRouteUrl(Object) GetRouteUrl(Object) GetRouteUrl(Object)

Gets the URL that corresponds to a set of route parameters.

(Inherited from Control)
GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters.

(Inherited from Control)
GetRouteUrl(String, Object) GetRouteUrl(String, Object) GetRouteUrl(String, Object) GetRouteUrl(String, Object)

Gets the URL that corresponds to a set of route parameters and a route name.

(Inherited from Control)
GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters and a route name.

(Inherited from Control)
GetStepType(WizardStepBase, Int32) GetStepType(WizardStepBase, Int32) GetStepType(WizardStepBase, Int32) GetStepType(WizardStepBase, Int32)

Returns the WizardStepType value for the specified WizardStepBase object.

GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control)

Returns the prefixed portion of the UniqueID property of the specified control.

(Inherited from Control)
HasControls() HasControls() HasControls() HasControls()

Determines if the server control contains any child controls.

(Inherited from Control)
HasEvents() HasEvents() HasEvents() HasEvents()

Returns a value indicating whether events are registered for the control or any child controls.

(Inherited from Control)
IsLiteralContent() IsLiteralContent() IsLiteralContent() IsLiteralContent()

Determines if the server control holds only literal content.

(Inherited from Control)
LoadControlState(Object) LoadControlState(Object) LoadControlState(Object) LoadControlState(Object)

Restores control state information.

LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

Loads view-state information.

MapPathSecure(String) MapPathSecure(String) MapPathSecure(String) MapPathSecure(String)

Retrieves the physical path that a virtual path, either absolute or relative, maps to.

(Inherited from Control)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MergeStyle(Style) MergeStyle(Style) MergeStyle(Style) MergeStyle(Style)

Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.

(Inherited from WebControl)
MoveTo(WizardStepBase) MoveTo(WizardStepBase) MoveTo(WizardStepBase) MoveTo(WizardStepBase)

Sets the specified WizardStepBase-derived object as the value for the ActiveStep property of the Wizard control.

OnActiveStepChanged(Object, EventArgs) OnActiveStepChanged(Object, EventArgs) OnActiveStepChanged(Object, EventArgs) OnActiveStepChanged(Object, EventArgs)

Raises the ActiveStepChanged event.

OnBubbleEvent(Object, EventArgs) OnBubbleEvent(Object, EventArgs) OnBubbleEvent(Object, EventArgs) OnBubbleEvent(Object, EventArgs)

Determines whether the event for the server control is passed up the page’s user interface server control hierarchy.

OnCancelButtonClick(EventArgs) OnCancelButtonClick(EventArgs) OnCancelButtonClick(EventArgs) OnCancelButtonClick(EventArgs)

Raises the CancelButtonClick event.

OnDataBinding(EventArgs) OnDataBinding(EventArgs) OnDataBinding(EventArgs) OnDataBinding(EventArgs)

Raises the DataBinding event.

(Inherited from Control)
OnFinishButtonClick(WizardNavigationEventArgs) OnFinishButtonClick(WizardNavigationEventArgs) OnFinishButtonClick(WizardNavigationEventArgs) OnFinishButtonClick(WizardNavigationEventArgs)

Raises the FinishButtonClick event.

OnInit(EventArgs) OnInit(EventArgs) OnInit(EventArgs) OnInit(EventArgs)

Raises the Init event.

OnLoad(EventArgs) OnLoad(EventArgs) OnLoad(EventArgs) OnLoad(EventArgs)

Raises the Load event.

(Inherited from Control)
OnNextButtonClick(WizardNavigationEventArgs) OnNextButtonClick(WizardNavigationEventArgs) OnNextButtonClick(WizardNavigationEventArgs) OnNextButtonClick(WizardNavigationEventArgs)

Raises the NextButtonClick event.

OnPreRender(EventArgs) OnPreRender(EventArgs) OnPreRender(EventArgs) OnPreRender(EventArgs)

Raises the PreRender event.

(Inherited from Control)
OnPreviousButtonClick(WizardNavigationEventArgs) OnPreviousButtonClick(WizardNavigationEventArgs) OnPreviousButtonClick(WizardNavigationEventArgs) OnPreviousButtonClick(WizardNavigationEventArgs)

Raises the PreviousButtonClick event.

OnSideBarButtonClick(WizardNavigationEventArgs) OnSideBarButtonClick(WizardNavigationEventArgs) OnSideBarButtonClick(WizardNavigationEventArgs) OnSideBarButtonClick(WizardNavigationEventArgs)

Raises the SideBarButtonClick event.

OnUnload(EventArgs) OnUnload(EventArgs) OnUnload(EventArgs) OnUnload(EventArgs)

Raises the Unload event.

(Inherited from Control)
OpenFile(String) OpenFile(String) OpenFile(String) OpenFile(String)

Gets a Stream used to read a file.

(Inherited from Control)
RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs)

Assigns any sources of the event and its information to the control's parent.

(Inherited from Control)
RecreateChildControls() RecreateChildControls() RecreateChildControls() RecreateChildControls()

Recreates the child controls in a control derived from CompositeControl.

(Inherited from CompositeControl)
RegisterCommandEvents(IButtonControl) RegisterCommandEvents(IButtonControl) RegisterCommandEvents(IButtonControl) RegisterCommandEvents(IButtonControl)

Registers a new instance of the CommandEventHandler class for the specified IButtonControl object.

RemovedControl(Control) RemovedControl(Control) RemovedControl(Control) RemovedControl(Control)

Called after a child control is removed from the Controls collection of the Control object.

(Inherited from Control)
Render(HtmlTextWriter) Render(HtmlTextWriter) Render(HtmlTextWriter) Render(HtmlTextWriter)

Renders the control to the specified writer.

RenderBeginTag(HtmlTextWriter) RenderBeginTag(HtmlTextWriter) RenderBeginTag(HtmlTextWriter) RenderBeginTag(HtmlTextWriter)

Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.

(Inherited from WebControl)
RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter)

Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

(Inherited from Control)
RenderContents(HtmlTextWriter) RenderContents(HtmlTextWriter) RenderContents(HtmlTextWriter) RenderContents(HtmlTextWriter)

Renders the contents of the control to the specified writer. This method is used primarily by control developers.

(Inherited from WebControl)
RenderControl(HtmlTextWriter) RenderControl(HtmlTextWriter) RenderControl(HtmlTextWriter) RenderControl(HtmlTextWriter)

Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.

(Inherited from Control)
RenderControl(HtmlTextWriter, ControlAdapter) RenderControl(HtmlTextWriter, ControlAdapter) RenderControl(HtmlTextWriter, ControlAdapter) RenderControl(HtmlTextWriter, ControlAdapter)

Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.

(Inherited from Control)
RenderEndTag(HtmlTextWriter) RenderEndTag(HtmlTextWriter) RenderEndTag(HtmlTextWriter) RenderEndTag(HtmlTextWriter)

Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.

(Inherited from WebControl)
ResolveAdapter() ResolveAdapter() ResolveAdapter() ResolveAdapter()

Gets the control adapter responsible for rendering the specified control.

(Inherited from Control)
ResolveClientUrl(String) ResolveClientUrl(String) ResolveClientUrl(String) ResolveClientUrl(String)

Gets a URL that can be used by the browser.

(Inherited from Control)
ResolveUrl(String) ResolveUrl(String) ResolveUrl(String) ResolveUrl(String)

Converts a URL into one that is usable on the requesting client.

(Inherited from Control)
SaveControlState() SaveControlState() SaveControlState() SaveControlState()

Save the control state.

SaveViewState() SaveViewState() SaveViewState() SaveViewState()

Saves the view state.

SetDesignModeState(IDictionary) SetDesignModeState(IDictionary) SetDesignModeState(IDictionary) SetDesignModeState(IDictionary)

Sets design-time data for a control.

(Inherited from Control)
SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod)

Assigns an event handler delegate to render the server control and its content into its parent control.

(Inherited from Control)
SetTraceData(Object, Object) SetTraceData(Object, Object) SetTraceData(Object, Object) SetTraceData(Object, Object)

Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.

(Inherited from Control)
SetTraceData(Object, Object, Object) SetTraceData(Object, Object, Object) SetTraceData(Object, Object, Object) SetTraceData(Object, Object, Object)

Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.

(Inherited from Control)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
TrackViewState() TrackViewState() TrackViewState() TrackViewState()

Tracks view state.

Events

ActiveStepChanged ActiveStepChanged ActiveStepChanged ActiveStepChanged

Occurs when the user switches to a new step in the control.

CancelButtonClick CancelButtonClick CancelButtonClick CancelButtonClick

Occurs when the Cancel button is clicked.

DataBinding DataBinding DataBinding DataBinding

Occurs when the server control binds to a data source.

(Inherited from Control)
Disposed Disposed Disposed Disposed

Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.

(Inherited from Control)
FinishButtonClick FinishButtonClick FinishButtonClick FinishButtonClick

Occurs when the Finish button is clicked.

Init Init Init Init

Occurs when the server control is initialized, which is the first step in its lifecycle.

(Inherited from Control)
Load Load Load Load

Occurs when the server control is loaded into the Page object.

(Inherited from Control)
NextButtonClick NextButtonClick NextButtonClick NextButtonClick

Occurs when the Next button is clicked.

PreRender PreRender PreRender PreRender

Occurs after the Control object is loaded but prior to rendering.

(Inherited from Control)
PreviousButtonClick PreviousButtonClick PreviousButtonClick PreviousButtonClick

Occurs when the Previous button is clicked.

SideBarButtonClick SideBarButtonClick SideBarButtonClick SideBarButtonClick

Occurs when a button in the sidebar area is clicked.

Unload Unload Unload Unload

Occurs when the server control is unloaded from memory.

(Inherited from Control)

Explicit Interface Implementations

IAttributeAccessor.GetAttribute(String) IAttributeAccessor.GetAttribute(String) IAttributeAccessor.GetAttribute(String) IAttributeAccessor.GetAttribute(String)

Gets an attribute of the Web control with the specified name.

(Inherited from WebControl)
IAttributeAccessor.SetAttribute(String, String) IAttributeAccessor.SetAttribute(String, String) IAttributeAccessor.SetAttribute(String, String) IAttributeAccessor.SetAttribute(String, String)

Sets an attribute of the Web control to the specified name and value.

(Inherited from WebControl)
ICompositeControlDesignerAccessor.RecreateChildControls() ICompositeControlDesignerAccessor.RecreateChildControls() ICompositeControlDesignerAccessor.RecreateChildControls() ICompositeControlDesignerAccessor.RecreateChildControls()

Enables a designer to recreate the composite control's collection of child controls in the design-time environment.

(Inherited from CompositeControl)
IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState()

For a description of this member, see GetDesignModeState().

(Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary)

For a description of this member, see SetDesignModeState(IDictionary).

(Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control)

For a description of this member, see SetOwnerControl(Control).

(Inherited from Control)
IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object)

For a description of this member, see AddParsedSubObject(Object).

(Inherited from Control)

Extension Methods

FindDataSourceControl(Control) FindDataSourceControl(Control) FindDataSourceControl(Control) FindDataSourceControl(Control)

Returns the data source that is associated with the data control for the specified control.

FindFieldTemplate(Control, String) FindFieldTemplate(Control, String) FindFieldTemplate(Control, String) FindFieldTemplate(Control, String)

Returns the field template for the specified column in the specified control's naming container.

FindMetaTable(Control) FindMetaTable(Control) FindMetaTable(Control) FindMetaTable(Control)

Returns the metatable object for the containing data control.

GetDefaultValues(INamingContainer) GetDefaultValues(INamingContainer) GetDefaultValues(INamingContainer) GetDefaultValues(INamingContainer)

Gets the collection of the default values for the specified data control.

GetMetaTable(INamingContainer) GetMetaTable(INamingContainer) GetMetaTable(INamingContainer) GetMetaTable(INamingContainer)

Gets the table metadata for the specified data control.

SetMetaTable(INamingContainer, MetaTable) SetMetaTable(INamingContainer, MetaTable) SetMetaTable(INamingContainer, MetaTable) SetMetaTable(INamingContainer, MetaTable)

Sets the table metadata for the specified data control.

SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>)

Sets the table metadata and default value mapping for the specified data control.

SetMetaTable(INamingContainer, MetaTable, Object) SetMetaTable(INamingContainer, MetaTable, Object) SetMetaTable(INamingContainer, MetaTable, Object) SetMetaTable(INamingContainer, MetaTable, Object)

Sets the table metadata and default value mapping for the specified data control.

TryGetMetaTable(INamingContainer, MetaTable) TryGetMetaTable(INamingContainer, MetaTable) TryGetMetaTable(INamingContainer, MetaTable) TryGetMetaTable(INamingContainer, MetaTable)

Determines whether table metadata is available.

EnableDynamicData(INamingContainer, Type) EnableDynamicData(INamingContainer, Type) EnableDynamicData(INamingContainer, Type) EnableDynamicData(INamingContainer, Type)

Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>)

Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type, Object) EnableDynamicData(INamingContainer, Type, Object) EnableDynamicData(INamingContainer, Type, Object) EnableDynamicData(INamingContainer, Type, Object)

Enables Dynamic Data behavior for the specified data control.

Applies to

See Also