WizardStepCollection.Insert Method (Int32, WizardStepBase)

 

Inserts the specified WizardStepBase-derived object into the collection at the specified index location.

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

public void Insert(
	int index,
	WizardStepBase wizardStep
)

Parameters

index
Type: System.Int32

The index location at which to insert the WizardStepBase-derived object.

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

The WizardStepBase-derived object to insert into the WizardStepCollection collection.

The Insert method adds the WizardStepBase-derived object to the collection at the specified index location.

Alternatively, you can use the AddAt method to add the WizardStepBase-derived object to the collection. To add a WizardStepBase-derived object to the end of the WizardStepCollection collection, use the Add method.

System_CAPS_noteNote

The Insert method and the AddAt method perform essentially the same function. When the Insert method is called, it simply passes the wizardStep and index parameters to the AddAt method.

The following code example demonstrates programmatically creating a Wizard control and using the Insert method to add WizardStepBase-derived 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="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 insert them
    // into the WizardStepCollection collection.
    for (int i = 0; i <= 5; i++)
    {
      WizardStepBase newStep = new WizardStep();
      newStep.ID = "Step" + (i + 1).ToString();
      WizardControl.WizardSteps.Insert(0, newStep);
    }

    WizardControl.ActiveStepIndex = 0;
    WizardControl.DisplaySideBar = true;

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

</script>

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

.NET Framework
Available since 2.0
Return to top
Show: