This documentation is archived and is not being maintained.

WizardStepCollection.Remove Method

Removes the specified WizardStepBase-derived object from the collection.

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

public void Remove (
	WizardStepBase wizardStep
)
public void Remove (
	WizardStepBase wizardStep
)
public function Remove (
	wizardStep : WizardStepBase
)
Not applicable.

Parameters

wizardStep

The WizardStepBase-derived object to remove from the collection.

Exception typeCondition

ArgumentNullException

The WizardStepBase-derived object passed in is a null reference (Nothing in Visual Basic).

Use the Remove method to remove the WizardStepBase-derived object from the WizardStepCollection collection. Alternatively, you can use the RemoveAt method to remove a WizardStepBase-derived object from a specified location in the WizardStepCollection collection.

The following example demonstrates how to use the Remove method to remove a WizardStepBase-derived object from the WizardStepCollection 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">

  // Remove Step2 from the WizardStepCollection collection
  // as the page is initialized. Then display the sidebar area
  // so that it is apparent that the WizardStep2 page is gone.
  
  void Page_Init()
  {
    Wizard1.WizardSteps.Remove(this.WizardStep2);
    Wizard1.DisplaySideBar = true;
  }
  
</script>

<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" 
        displaysidebar="false" >
        <WizardSteps>
          <asp:WizardStep id="WizardStep1" 
            runat="server" 
            title="Step 1">
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep2" 
            runat="server" 
            title="Step 2">
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep3" 
            runat="server" 
            title="Step 3">
          </asp:WizardStep>
        </WizardSteps>
        <HeaderTemplate>
          <b>WizardStepCollection Remove Example</b>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: