Wizard.MoveTo Method (System.Web.UI.WebControls)

MoveTo Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Wizard..::.MoveTo Method

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

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

Syntax

Visual Basic (Declaration)

Public Sub MoveTo ( _
    wizardStep As WizardStepBase _
)

Visual Basic (Usage)

Dim instance As Wizard
Dim wizardStep As WizardStepBase

instance.MoveTo(wizardStep)

public void MoveTo(
    WizardStepBase wizardStep
)

Visual C++

public:
void MoveTo(
    WizardStepBase^ wizardStep
)

JScript

public function MoveTo(
    wizardStep : WizardStepBase
)

Parameters

wizardStep: Type: System.Web.UI.WebControls..::.WizardStepBase
The WizardStepBase-derived object to set as the ActiveStep.

Exceptions

Exception	Condition
ArgumentNullException	The value of the WizardStepBase-derived object passed in is nullNothingnullptra null reference (Nothing in Visual Basic).
ArgumentException	The ActiveStepIndex of the associated WizardStepBase-derived object passed in is equal to -1.

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.

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.

Visual Basic

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

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

Wizard Class

Wizard Members

System.Web.UI.WebControls Namespace

Other Resources

Wizard Web Server Control Overview