Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

WizardStepCollection Class

.NET Framework 4

Represents a collection of WizardStepBase-derived objects in a control that acts as a wizard. This class cannot be inherited.

System.Object
  System.Web.UI.WebControls.WizardStepCollection

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
C#
C++
F#
VB
Copy 
public sealed class WizardStepCollection : IList, 
	ICollection, IEnumerable

The WizardStepCollection type exposes the following members.

  Name Description
Public property Count Gets the number of WizardStepBase-derived objects in the Wizard control's WizardStepCollection collection.
Public property IsReadOnly Gets a value indicating whether the WizardStepBase-derived objects in the collection can be modified.
Public property IsSynchronized Gets a value indicating whether access to the collection is synchronized (thread-safe).
Public property Item Gets a WizardStepBase-derived object from the collection at the specified index.
Public property SyncRoot Gets an object that can be used to synchronize access to the collection.
Top
  Name Description
Public method Add Appends the specified WizardStepBase-derived object to the end of the collection.
Public method AddAt Adds the specified WizardStepBase-derived object to the collection at the specified index location.
Public method Clear Removes all WizardStepBase-derived objects from the collection.
Public method Contains Determines whether the WizardStepCollection collection contains a specific WizardStepBase-derived object.
Public method CopyTo Copies all the items from a WizardStepCollection collection to a compatible one-dimensional array of WizardStepBase objects, starting at the specified index in the target array.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an IEnumerator-implemented object that can be used to iterate through the WizardStepBase-derived objects in the collection.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Determines the index value that represents the position of the specified WizardStepBase-derived object in the collection.
Public method Insert Inserts the specified WizardStepBase-derived object into the collection at the specified index location.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Remove Removes the specified WizardStepBase-derived object from the collection.
Public method RemoveAt Removes the WizardStepBase-derived object from the collection at the specified location.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public Extension Method AsParallel Enables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension Method AsQueryable Converts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension Method Cast<TResult> Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension Method OfType<TResult> Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top
  Name Description
Explicit interface implemetation Private method ICollection.CopyTo Infrastructure. Copies all the items from a WizardStepCollection collection to a one-dimensional array, starting at the specified index in the target array.
Explicit interface implemetation Private method IList.Add Infrastructure. Appends the specified object to the end of the collection.
Explicit interface implemetation Private method IList.Contains Infrastructure. Determines whether the collection contains the specified object.
Explicit interface implemetation Private method IList.IndexOf Infrastructure. Determines the index value that represents the position of the specified object in the collection.
Explicit interface implemetation Private method IList.Insert Infrastructure. Inserts the specified object in the collection at the specified position.
Explicit interface implemetation Private property IList.IsFixedSize Infrastructure. Gets a value indicating whether the collection has a fixed size.
Explicit interface implemetation Private property IList.Item Infrastructure. Gets the object at the specified index in the collection.
Explicit interface implemetation Private method IList.Remove Infrastructure. Removes the specified object from the collection.
Top

The WizardStepCollection class is used to store and manage a collection of WizardStepBase-derived objects in a control that acts as a wizard, such as the CreateUserWizard control or the Wizard control. For example, the Wizard control uses the WizardStepCollection class for its WizardSteps property.

There are multiple ways you can access the WizardStepBase-derived objects in the WizardStepCollection:

  • Use the Item property to directly access a WizardStepBase-derived object at a specific zero-based index.

  • Use the GetEnumerator method to create an enumerator that can be used to iterate through the collection.

  • Use the CopyTo method to copy the contents of the WizardStepCollection collection into an Array object.

The following example demonstrates how to populate the WizardStepCollection collection using declarative syntax.

C#
VB
Copy 

<%@ Page Language="C#" %>

<!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" >
        <WizardSteps>
          <asp:WizardStep id="Step1" 
            runat="server" 
            title="Step 1">
          </asp:WizardStep>
          <asp:WizardStep id="Step2" 
            runat="server" 
            title="Step 2">
          </asp:WizardStep>
          <asp:WizardStep id="Step3" 
            runat="server" 
            title="Step 3">
          </asp:WizardStep>
          <asp:WizardStep id="Step4" 
            runat="server" 
            title="Step 4">
          </asp:WizardStep>
          <asp:WizardStep id="Step5" 
            runat="server" 
            title="Step 5">
          </asp:WizardStep>
          <asp:WizardStep id="Step6" 
            runat="server" 
            title="Step 6">
          </asp:WizardStep>
        </WizardSteps>
        <HeaderTemplate>
          <b>WizardStepCollection Example</b>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

The following example demonstrates how to programmatically populate a WizardStepCollection collection.

C#
VB
Copy 

<%@ Page Language="C#" CodeFile="WizardStepCollection.cs" Inherits="WizardStepCollectioncs_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>WizardStepCollection Example</title>
</head>
<body>
    <form id="Form1" runat="server">
      <h3>WizardStepCollection Example</h3>
      <asp:PlaceHolder id="PlaceHolder1" 
        runat="server" />
    </form>
  </body>
</html>

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

C#
VB
Copy 

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 WizardStepCollectioncs_aspx : System.Web.UI.Page
{ 

    void Page_Load(object sender, EventArgs e)
    {
        // Programmatically create a wizard control.
        Wizard Wizard1 = new Wizard();

        // Create steps for the wizard control and insert them
        // into the WizardStepCollection collection.
        for (int i = 0; i <= 5; i++)
        {
            WizardStepBase newStep = new WizardStep();
            newStep.ID = "Step" + (i + 1).ToString();
            newStep.Title = "Step " + (i + 1).ToString();
            Wizard1.WizardSteps.Add(newStep);
        }

        // Display the wizard control on the Web page.
        PlaceHolder1.Controls.Add(Wizard1);
    }

}

.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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ