This documentation is archived and is not being maintained.

Wizard.WizardSteps Property

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

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

[ThemeableAttribute(false)]
[PersistenceModeAttribute(PersistenceMode.InnerProperty)]
public virtual WizardStepCollection WizardSteps { get; }

Property Value

Type: System.Web.UI.WebControls.WizardStepCollection
A WizardStepCollection representing all the WizardStepBase objects defined for the Wizard.

The WizardSteps property returns a collection of WizardStepBase objects that make up the Wizard control. You can use the WizardSteps collection to access the WizardStepBase objects that are contained in the Wizard control programmatically. Use the Add, Remove, Clear, and Insert methods to manipulate the WizardStepBase objects in the collection programmatically.

NoteNote

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.

If the Wizard control contains multiple WizardStepCollection collections, the collections will be merged.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

The following code example demonstrates how to create a Wizard control programmatically and how to use the Add method to add WizardStepBase objects to the WizardSteps collection.


<%@ page language="C#"%>

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

<script runat="server">

  // Programmatically create a Wizard control and dynamically
  // add WizardStep objects to it.    

  void Page_Load(object sender, EventArgs e) 
  {
    Wizard WizardControl = new Wizard();

    // Create some steps for the wizard and add them
    // to the Wizard control.
    for (int i = 0; i <= 5; i++)
    {
      WizardStepBase newStep = new WizardStep();
      newStep.ID = "Step" + (i + 1).ToString();
      WizardControl.WizardSteps.Add(newStep);
    }

    // Display the wizard on the page.
    PlaceHolder1.Controls.Add(WizardControl);
  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>WizardSteps Example</title>
</head>
<body>
    <form id="Form1" runat="server">
      <h3>WizardSteps Example</h3>
      <asp:PlaceHolder id="PlaceHolder1" 
        runat="server" />
    </form>
  </body>
</html>


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: