Wizard.MoveTo(WizardStepBase) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

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.

Sets the specified WizardStepBase-derived object as the value for the ActiveStep property of the Wizard control.

public:
 void MoveTo(System::Web::UI::WebControls::WizardStepBase ^ wizardStep);

public void MoveTo (System.Web.UI.WebControls.WizardStepBase wizardStep);

member this.MoveTo : System.Web.UI.WebControls.WizardStepBase -> unit

Public Sub MoveTo (wizardStep As WizardStepBase)

Parameters

wizardStep: WizardStepBase

The WizardStepBase-derived object to set as the ActiveStep.

Exceptions

ArgumentNullException

The value of the WizardStepBase-derived object passed in is null.

ArgumentException

The ActiveStepIndex of the associated WizardStepBase-derived object passed in is equal to -1.

Examples

The following code example demonstrates how to use the MoveTo method to control the ActiveStep property of the Wizard control. If the value of CheckBox1.Checked is true, the ActiveStep property is set to Wizard1.Step3; otherwise, the ActiveStep property is set to Wizard1.Step2.

<%@ 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">

  void OnActiveStepChanged(object sender, EventArgs e)
  {
    // If the ActiveStep is changing to Step2, check to see whether the 
    // CheckBox1 check box is selected.  If it is, skip to the Step3 step. 
    if (Wizard1.ActiveStepIndex == Wizard1.WizardSteps.IndexOf(this.WizardStep2))
    {
      if (this.CheckBox1.Checked)
      {
        Wizard1.MoveTo(this.WizardStep3);
      }
      else
      {
        Wizard1.MoveTo(this.WizardStep2);
      }
    }
  }
  
</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"
        onactivestepchanged="OnActiveStepChanged">
        <WizardSteps>
          <asp:WizardStep id="WizardStep1" 
            title="Step 1" 
            runat="server">
            <asp:CheckBox id="CheckBox1" 
              runat="Server" 
              text="Select this check box to skip Step 2." />
              You are currently on Step 1.
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep2" 
            title="Step 2" 
            runat="server">
            You are currently on Step 2.
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep3" 
            runat="server" 
            title="Step 3">
            You are currently on Step 3.
          </asp:WizardStep>
        </WizardSteps>
        <HeaderTemplate>
          <b>MoveTo 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">
  
  Sub OnActiveStepChanged(ByVal sender As Object, ByVal e As EventArgs)

    ' If the ActiveStep is changing to Step2, check to see whether the 
    ' CheckBox1 check box is selected.  If it is, skip to the Step3 step.
    If Wizard1.ActiveStepIndex = Wizard1.WizardSteps.IndexOf(Me.WizardStep2) Then
    
      If (Me.CheckBox1.Checked) Then
        Wizard1.MoveTo(Me.WizardStep3)
      Else
        Wizard1.MoveTo(Me.WizardStep2)
      End If
    
    End If

  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" 
        onactivestepchanged="OnActiveStepChanged">
        <WizardSteps>
          <asp:WizardStep id="WizardStep1" 
            title="Step 1" 
            runat="server">
            <asp:CheckBox id="CheckBox1" 
              runat="Server" 
              text="Select this check box to skip Step 2." />
              You are currently on Step 1.
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep2" 
            title="Step 2" 
            runat="server">
            You are currently on Step 2.
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep3" 
            runat="server" 
            title="Step 3">
            You are currently on Step 3.
          </asp:WizardStep>
        </WizardSteps>
        <HeaderTemplate>
          <b>MoveTo Example</b>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

Remarks

Use the MoveTo method to control which WizardStepBase-derived object is set as the value for the ActiveStep property in the Wizard control programmatically. This way, you can change the ActiveStep property dynamically based on other conditions during run time.

Applies to

Share via