Wizard Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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[<System.ComponentModel.Bindable(false)>]
type Wizard = class
inherit CompositeControlPublic 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
Wizardcontrol 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() |
Initializes a new instance of the Wizard class. |
Fields
| CancelButtonID |
Specifies the identifier for the Cancel button. This field is static and read-only. |
| CancelCommandName |
Retrieves the command name for the Cancel button. This field is static and read-only. |
| CustomFinishButtonID |
Retrieves the identifier for a custom Finish button. This field is static and read-only. |
| CustomNextButtonID |
Retrieves the identifier for a custom Next button. This field is static and read-only. |
| CustomPreviousButtonID |
Retrieves the identifier for a custom Previous button. This field is static and read-only. |
| DataListID |
Retrieves the identifier for the sidebar DataList collection. This field is static and read-only. |
| FinishButtonID |
Retrieves the identifier for the Finish button. This field is static and read-only. |
| FinishPreviousButtonID |
Retrieves the identifier for the Previous button on the Finish step. This field is static and read-only. |
| HeaderPlaceholderId |
Gets the ID of the HeaderTemplate placeholder in a Wizard control. |
| MoveCompleteCommandName |
Retrieves the command name that is associated with the Finish button. This field is static and read-only. |
| MoveNextCommandName |
Retrieves the command name that is associated with the Next button. This field is static and read-only. |
| MovePreviousCommandName |
Retrieves the command name that is associated with the Previous button. This field is static and read-only. |
| MoveToCommandName |
Retrieves the command name that is associated with each of the sidebar buttons. This field is static and read-only. |
| NavigationPlaceholderId |
Gets the ID of the StartNavigationTemplate placeholder in a Wizard control. |
| SideBarButtonID |
Retrieves the identifier that is associated with each of the sidebar buttons. This field is static and read-only. |
| SideBarPlaceholderId |
Gets the ID of the SideBarTemplate placeholder in a Wizard control. |
| StartNextButtonID |
Retrieves the identifier that is associated with the Next button on the Start step. This field is static and read-only. |
| StepNextButtonID |
Retrieves the identifier that is associated with the Next button. This field is static and read-only. |
| StepPreviousButtonID |
Retrieves the identifier that is associated with the Previous button. This field is static and read-only. |
| WizardStepPlaceholderId |
Gets the ID of the WizardStep placeholder in a Wizard control. |
Properties
| AccessKey |
Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl) |
| ActiveStep |
Gets the step in the WizardSteps collection that is currently displayed to the user. |
| ActiveStepIndex |
Gets or sets the index of the current WizardStepBase object. |
| Adapter |
Gets the browser-specific adapter for the control. (Inherited from Control) |
| AppRelativeTemplateSourceDirectory |
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control) |
| Attributes |
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl) |
| BackColor |
Gets or sets the background color of the Web server control. (Inherited from WebControl) |
| BindingContainer |
Gets the control that contains this control's data binding. (Inherited from Control) |
| BorderColor |
Gets or sets the border color of the Web control. (Inherited from WebControl) |
| BorderStyle |
Gets or sets the border style of the Web server control. (Inherited from WebControl) |
| BorderWidth |
Gets or sets the border width of the Web server control. (Inherited from WebControl) |
| CancelButtonImageUrl |
Gets or sets the URL of the image displayed for the Cancel button. |
| CancelButtonStyle |
Gets a reference to a collection of style properties that define the appearance of the Cancel button. |
| CancelButtonText |
Gets or sets the text caption that is displayed for the Cancel button. |
| CancelButtonType |
Gets or sets the type of button that is rendered as the Cancel button. |
| CancelDestinationPageUrl |
Gets or sets the URL that the user is directed to when they click the Cancel button. |
| CellPadding |
Gets or sets the amount of space between the contents of the cell and the cell border. |
| CellSpacing |
Gets or sets the amount of space between cells. |
| ChildControlsCreated |
Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control) |
| ClientID |
Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control) |
| ClientIDMode |
Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control) |
| ClientIDSeparator |
Gets a character value representing the separator character used in the ClientID property. (Inherited from Control) |
| Context |
Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control) |
| Controls |
Gets a ControlCollection object that represents the child controls in a CompositeControl. (Inherited from CompositeControl) |
| ControlStyle |
Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl) |
| 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 |
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl) |
| DataItemContainer |
Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control) |
| DataKeysContainer |
Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control) |
| DesignMode |
Gets a value indicating whether a control is being used on a design surface. (Inherited from Control) |
| DisplayCancelButton |
Gets or sets a Boolean value indicating whether to display a Cancel button. |
| DisplaySideBar |
Gets or sets a Boolean value indicating whether to display the sidebar area on the Wizard control. |
| Enabled |
Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl) |
| EnableTheming |
Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl) |
| 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 |
Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control) |
| FinishCompleteButtonImageUrl |
Gets or sets the URL of the image that is displayed for the Finish button. |
| FinishCompleteButtonStyle |
Gets a reference to a Style object that defines the settings for the Finish button. |
| FinishCompleteButtonText |
Gets or sets the text caption that is displayed for the Finish button. |
| FinishCompleteButtonType |
Gets or sets the type of button that is rendered as the Finish button. |
| FinishDestinationPageUrl |
Gets or sets the URL that the user is redirected to when they click the Finish button. |
| FinishNavigationTemplate |
Gets or sets the template that is used to display the navigation area on the Finish step. |
| FinishPreviousButtonImageUrl |
Gets or sets the URL of the image that is displayed for the Previous button on the Finish step. |
| FinishPreviousButtonStyle |
Gets a reference to a Style object that defines the settings for the Previous button on the Finish step. |
| FinishPreviousButtonText |
Gets or sets the text caption that is displayed for the Previous button on the Finish step. |
| FinishPreviousButtonType |
Gets or sets the type of button that is rendered as the Previous button on the Finish step. |
| Font |
Gets the font properties associated with the Web server control. (Inherited from WebControl) |
| ForeColor |
Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl) |
| HasAttributes |
Gets a value indicating whether the control has attributes set. (Inherited from WebControl) |
| HasChildViewState |
Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control) |
| HeaderStyle |
Gets a reference to a Style object that defines the settings for the header area on the control. |
| HeaderTemplate |
Gets or sets the template that is used to display the header area on the control. |
| HeaderText |
Gets or sets the text caption that is displayed for the header area on the control. |
| Height |
Gets or sets the height of the Web server control. (Inherited from WebControl) |
| ID |
Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control) |
| IdSeparator |
Gets the character used to separate control identifiers. (Inherited from Control) |
| IsChildControlStateCleared |
Gets a value indicating whether controls contained within this control have control state. (Inherited from Control) |
| IsEnabled |
Gets a value indicating whether the control is enabled. (Inherited from WebControl) |
| IsTrackingViewState |
Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control) |
| IsViewStateEnabled |
Gets a value indicating whether view state is enabled for this control. (Inherited from Control) |
| LayoutTemplate |
Gets or sets the custom content of the root container in a Wizard control. |
| LoadViewStateByID |
Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control) |
| 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 |
Gets a reference to a Style object that defines the settings for the buttons in the navigation area on the control. |
| NavigationStyle |
Gets a reference to a Style object that defines the settings for the navigation area on the control. |
| Page |
Gets a reference to the Page instance that contains the server control. (Inherited from Control) |
| Parent |
Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control) |
| RenderingCompatibility |
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control) |
| SideBarButtonStyle |
Gets a reference to a Style object that defines the settings for the buttons on the sidebar. |
| SideBarStyle |
Gets a reference to a Style object that defines the settings for the sidebar area on the control. |
| SideBarTemplate |
Gets or sets the template that is used to display the sidebar area on the control. |
| Site |
Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control) |
| SkinID |
Gets or sets the skin to apply to the control. (Inherited from WebControl) |
| 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 |
Gets or sets the template that is used to display the navigation area on the Start step of the Wizard control. |
| StartNextButtonImageUrl |
Gets or sets the URL of the image that is displayed for the Next button on the Start step. |
| StartNextButtonStyle |
Gets a reference to a Style object that defines the settings for the Next button on the Start step. |
| StartNextButtonText |
Gets or sets the text caption that is displayed for the Next button on the Start step. |
| StartNextButtonType |
Gets or sets the type of button that is rendered as the Next button on the Start step. |
| 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 |
Gets or sets the URL of the image that is displayed for the Next button. |
| StepNextButtonStyle |
Gets a reference to the Style object that defines the settings for the Next button. |
| StepNextButtonText |
Gets or sets the text caption that is displayed for the Next button. |
| StepNextButtonType |
Gets or sets the type of button that is rendered as the Next button. |
| StepPreviousButtonImageUrl |
Gets or sets the URL of the image that is displayed for the Previous button. |
| StepPreviousButtonStyle |
Gets a reference to a Style object that defines the settings for the Previous button. |
| StepPreviousButtonText |
Gets or sets the text caption that is displayed for the Previous button. |
| StepPreviousButtonType |
Gets or sets the type of button that is rendered as the Previous button. |
| StepStyle |
Gets a reference to a Style object that defines the settings for the WizardStep objects. |
| 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 |
Gets a value that indicates whether the control should set the |
| TabIndex |
Gets or sets the tab index of the Web server control. (Inherited from WebControl) |
| TagKey |
Gets the HtmlTextWriterTag value that corresponds to the Wizard control. |
| TagName |
Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl) |
| TemplateControl |
Gets or sets a reference to the template that contains this control. (Inherited from Control) |
| TemplateSourceDirectory |
Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control) |
| ToolTip |
Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl) |
| UniqueID |
Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control) |
| 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 |
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 |
Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control) |
| ViewStateMode |
Gets or sets the view-state mode of this control. (Inherited from Control) |
| Visible |
Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control) |
| Width |
Gets or sets the width of the Web server control. (Inherited from WebControl) |
| WizardSteps |
Gets a collection containing all the WizardStepBase objects that are defined for the control. |
Methods
| 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) |
Called after a child control is added to the Controls collection of the Control object. (Inherited from Control) |
| 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) |
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) |
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) |
Applies the style properties defined in the page style sheet to the control. (Inherited from Control) |
| BeginRenderTracing(TextWriter, Object) |
Begins design-time tracing of rendering data. (Inherited from Control) |
| 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() |
Sets the cached ClientID value to |
| ClearChildControlState() |
Deletes the control-state information for the server control's child controls. (Inherited from Control) |
| ClearChildState() |
Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control) |
| ClearChildViewState() |
Deletes the view-state information for all the server control's child controls. (Inherited from Control) |
| ClearEffectiveClientIDMode() |
Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control) |
| 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() |
Creates child controls. |
| CreateControlCollection() |
Creates control collection. |
| CreateControlHierarchy() |
Creates the hierarchy of child controls that make up the control. |
| CreateControlStyle() |
Creates control style. |
| DataBind() |
Binds a data source to the CompositeControl and all its child controls. (Inherited from CompositeControl) |
| 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() |
Binds a data source to the server control's child controls. (Inherited from Control) |
| Dispose() |
Enables a server control to perform final clean up before it is released from memory. (Inherited from Control) |
| EndRenderTracing(TextWriter, Object) |
Ends design-time tracing of rendering data. (Inherited from Control) |
| EnsureChildControls() |
Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control) |
| EnsureID() |
Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control) |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| FindControl(String) |
Searches the current naming container for a server control with the specified |
| FindControl(String, Int32) |
Searches the current naming container for a server control with the specified |
| Focus() |
Sets input focus to a control. (Inherited from Control) |
| GetDesignModeState() |
Gets the design mode state. |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetHistory() |
Returns a collection of WizardStepBase objects that have been accessed. |
| GetRouteUrl(Object) |
Gets the URL that corresponds to a set of route parameters. (Inherited from Control) |
| GetRouteUrl(RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters. (Inherited from Control) |
| GetRouteUrl(String, Object) |
Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control) |
| GetRouteUrl(String, RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control) |
| GetStepType(WizardStepBase, Int32) |
Returns the WizardStepType value for the specified WizardStepBase object. |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| GetUniqueIDRelativeTo(Control) |
Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control) |
| HasControls() |
Determines if the server control contains any child controls. (Inherited from Control) |
| HasEvents() |
Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control) |
| IsLiteralContent() |
Determines if the server control holds only literal content. (Inherited from Control) |
| LoadControlState(Object) |
Restores control state information. |
| LoadViewState(Object) |
Loads view-state information. |
| MapPathSecure(String) |
Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| 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) |
Sets the specified WizardStepBase-derived object as the value for the ActiveStep property of the Wizard control. |
| OnActiveStepChanged(Object, EventArgs) |
Raises the ActiveStepChanged event. |
| OnBubbleEvent(Object, EventArgs) |
Determines whether the event for the server control is passed up the page's user interface server control hierarchy. |
| OnCancelButtonClick(EventArgs) |
Raises the CancelButtonClick event. |
| OnDataBinding(EventArgs) |
Raises the DataBinding event. (Inherited from Control) |
| OnFinishButtonClick(WizardNavigationEventArgs) |
Raises the FinishButtonClick event. |
| OnInit(EventArgs) |
Raises the Init event. |
| OnLoad(EventArgs) |
Raises the Load event. (Inherited from Control) |
| OnNextButtonClick(WizardNavigationEventArgs) |
Raises the NextButtonClick event. |
| OnPreRender(EventArgs) |
Raises the PreRender event. (Inherited from Control) |
| OnPreviousButtonClick(WizardNavigationEventArgs) |
Raises the PreviousButtonClick event. |
| OnSideBarButtonClick(WizardNavigationEventArgs) |
Raises the SideBarButtonClick event. |
| OnUnload(EventArgs) |
Raises the Unload event. (Inherited from Control) |
| OpenFile(String) |
Gets a Stream used to read a file. (Inherited from Control) |
| RaiseBubbleEvent(Object, EventArgs) |
Assigns any sources of the event and its information to the control's parent. (Inherited from Control) |
| RecreateChildControls() |
Recreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl) |
| RegisterCommandEvents(IButtonControl) |
Registers a new instance of the CommandEventHandler class for the specified IButtonControl object. |
| RemovedControl(Control) |
Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control) |
| Render(HtmlTextWriter) |
Renders the control to the specified writer. |
| 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) |
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) |
Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl) |
| 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) |
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control) |
| 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() |
Gets the control adapter responsible for rendering the specified control. (Inherited from Control) |
| ResolveClientUrl(String) |
Gets a URL that can be used by the browser. (Inherited from Control) |
| ResolveUrl(String) |
Converts a URL into one that is usable on the requesting client. (Inherited from Control) |
| SaveControlState() |
Save the control state. |
| SaveViewState() |
Saves the view state. |
| SetDesignModeState(IDictionary) |
Sets design-time data for a control. (Inherited from Control) |
| 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) |
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) |
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() |
Returns a string that represents the current object. (Inherited from Object) |
| TrackViewState() |
Tracks view state. |
Events
| ActiveStepChanged |
Occurs when the user switches to a new step in the control. |
| CancelButtonClick |
Occurs when the Cancel button is clicked. |
| DataBinding |
Occurs when the server control binds to a data source. (Inherited from Control) |
| 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 |
Occurs when the Finish button is clicked. |
| Init |
Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control) |
| Load |
Occurs when the server control is loaded into the Page object. (Inherited from Control) |
| NextButtonClick |
Occurs when the Next button is clicked. |
| PreRender |
Occurs after the Control object is loaded but prior to rendering. (Inherited from Control) |
| PreviousButtonClick |
Occurs when the Previous button is clicked. |
| SideBarButtonClick |
Occurs when a button in the sidebar area is clicked. |
| Unload |
Occurs when the server control is unloaded from memory. (Inherited from Control) |
Explicit Interface Implementations
| IAttributeAccessor.GetAttribute(String) |
Gets an attribute of the Web control with the specified name. (Inherited from WebControl) |
| IAttributeAccessor.SetAttribute(String, String) |
Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl) |
| ICompositeControlDesignerAccessor.RecreateChildControls() |
Enables a designer to recreate the composite control's collection of child controls in the design-time environment. (Inherited from CompositeControl) |
| IControlBuilderAccessor.ControlBuilder |
For a description of this member, see ControlBuilder. (Inherited from Control) |
| IControlDesignerAccessor.GetDesignModeState() |
For a description of this member, see GetDesignModeState(). (Inherited from Control) |
| IControlDesignerAccessor.SetDesignModeState(IDictionary) |
For a description of this member, see SetDesignModeState(IDictionary). (Inherited from Control) |
| IControlDesignerAccessor.SetOwnerControl(Control) |
For a description of this member, see SetOwnerControl(Control). (Inherited from Control) |
| IControlDesignerAccessor.UserData |
For a description of this member, see UserData. (Inherited from Control) |
| IDataBindingsAccessor.DataBindings |
For a description of this member, see DataBindings. (Inherited from Control) |
| IDataBindingsAccessor.HasDataBindings |
For a description of this member, see HasDataBindings. (Inherited from Control) |
| IExpressionsAccessor.Expressions |
For a description of this member, see Expressions. (Inherited from Control) |
| IExpressionsAccessor.HasExpressions |
For a description of this member, see HasExpressions. (Inherited from Control) |
| IParserAccessor.AddParsedSubObject(Object) |
For a description of this member, see AddParsedSubObject(Object). (Inherited from Control) |
Extension Methods
| FindDataSourceControl(Control) |
Returns the data source that is associated with the data control for the specified control. |
| FindFieldTemplate(Control, String) |
Returns the field template for the specified column in the specified control's naming container. |
| FindMetaTable(Control) |
Returns the metatable object for the containing data control. |
| GetDefaultValues(INamingContainer) |
Gets the collection of the default values for the specified data control. |
| GetMetaTable(INamingContainer) |
Gets the table metadata for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable) |
Sets the table metadata for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) |
Sets the table metadata and default value mapping for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable, Object) |
Sets the table metadata and default value mapping for the specified data control. |
| TryGetMetaTable(INamingContainer, MetaTable) |
Determines whether table metadata is available. |
| EnableDynamicData(INamingContainer, Type) |
Enables Dynamic Data behavior for the specified data control. |
| EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) |
Enables Dynamic Data behavior for the specified data control. |
| EnableDynamicData(INamingContainer, Type, Object) |
Enables Dynamic Data behavior for the specified data control. |
