Wizard.ActiveStepIndex Property

 

Gets or sets the index of the current WizardStepBase object.

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

[<ThemeableAttribute(false)>]
abstract ActiveStepIndex : int with get, set
[<ThemeableAttribute(false)>]
override ActiveStepIndex : int with get, set

Property Value

Type: System.Int32

The index of the WizardStepBase that is currently displayed in the Wizard control.

Exception Condition
ArgumentOutOfRangeException

The selected value is higher than the number of wizard steps defined in the WizardSteps collection.

The ActiveStepIndex property provides the zero-based index of the WizardStepBase object that is currently displayed in the Wizard control. You can programmatically set the ActiveStepIndex property to control which step is displayed to the user at run time.

System_CAPS_noteNote

If you are using Microsoft Visual Studio 2005, note that the ActiveStepIndex is persisted in Source view. If you change the WizardSteps property in Design view by clicking the sidebar buttons, and you then run the page, the first step of the Wizard control might not be shown because the ActiveStepIndex might be pointing to a different step.

If you set the value of ActiveStepIndex to -1 to support a wizard with no steps by default, the following behavior occurs:

  • If you declaratively set ActiveStepIndex to -1 or set it to -1 as a default value, the control will always try to render the first step in the wizard.

  • If you programmatically set ActiveStepIndex to -1, the control will not render.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

The following code example demonstrates how to use the ActiveStepIndex property to set 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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: