WizardStepCollection.Add Method (WizardStepBase)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Appends the specified WizardStepBase-derived object to the end of the collection.

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

Public Sub Add (
	wizardStep As WizardStepBase
)

Parameters

wizardStep
Type: System.Web.UI.WebControls.WizardStepBase

The WizardStepBase-derived object to append to the WizardStepCollection collection.

Exception Condition
ArgumentNullException

The WizardStepBase-derived object passed in is null.

The Add method adds the WizardStepBase-derived object to the end of the WizardStepCollection collection. To add a WizardStepBase-derived object to the collection at a specific index location, use the AddAt method.

The following code example demonstrates programmatically creating a Wizard control and using the Add method to add WizardStepBase-derived WizardStep objects to the WizardSteps collection. Note that in the example, the WizardSteps property of the Wizard control is an instance of the WizardStepCollection class.

<%@ Page Language="VB" %>

<!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.    

  Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)

    Dim WizardControl As New Wizard()

    ' Create some steps for the wizard and add them to 
    ' the Wizard control.
    For i As Integer = 0 To 5
      Dim newStep As WizardStepBase = New WizardStep()
      newStep.ID = "Step" + (i + 1).ToString()
      WizardControl.WizardSteps.Add(newStep)
    Next

    ' Display the wizard on the page.
    PlaceHolder1.Controls.Add(WizardControl)

  End Sub

</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
Available since 2.0
Return to top
Show: