WizardStepCollection.Remove(WizardStepBase) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Removes the specified WizardStepBase-derived object from the collection.
public:
void Remove(System::Web::UI::WebControls::WizardStepBase ^ wizardStep);
public void Remove (System.Web.UI.WebControls.WizardStepBase wizardStep);
member this.Remove : System.Web.UI.WebControls.WizardStepBase -> unit
Public Sub Remove (wizardStep As WizardStepBase)
Parameters
- wizardStep
- WizardStepBase
The WizardStepBase-derived object to remove from the collection.
Exceptions
The WizardStepBase-derived object passed in is null
.
Examples
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>
<%@ 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">
' 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.
Sub Page_Init()
Wizard1.WizardSteps.Remove(Me.WizardStep2)
Wizard1.DisplaySideBar = True
End Sub
</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>
Remarks
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.