System.Web
2.0.0.0
System.Web.UI.WebControls.View
System.ComponentModel.ToolboxItem("")
System.ComponentModel.Bindable(false)
System.Web.UI.ControlBuilder(typeof(System.Web.UI.WebControls.WizardStepControlBuilder))
You cannot directly create an instance of the class. Instead, this class is inherited by the class and the class to provide the basic functionality of a step in a control that acts as a wizard.
You can derive from the class to create a custom class that represents a unique step in a wizard control.
Implements the basic functionality required by a step in a control.
Constructor
To be added.
Initializes a new instance of the class.
2.0.0.0
Property
System.Web.UI.Filterable(false)
System.Web.UI.Themeable(false)
System.ComponentModel.DefaultValue(true)
System.Boolean
To be added.
The property can be used to enforce linear navigation in a control. If each step has its property set to false, the user will not be able to return to a step after it has been accessed. One scenario where you might use this functionality is to disallow a user to return to a step after it has been completed because you are persisting the data to a database as each step is completed. If you save the data after each step and allow the user to return to a step and change information after it has been saved, the saved data might become corrupted. By setting the property to false, once the user has left a step, he or she will not be able to return to it and change any values.
The property determines how and when the Previous button is not rendered. The following table describes the Previous button rendering behavior.
-
Scenario
Behavior
-
Linear: Step1 has set to false and user action goes to step 2.
Step 2 does not display the Previous button.
-
Non-Linear: Step1 has set to false and user action goes to step 3.
Step 3 does not display the Previous button.
-
SideBar Buttons: Step 2 has set to false , is set to true, and a user clicks on the SideBar button.
No buttons are automatically disabled on the sidebar when is set to false. If a user clicks the button, the action is ignored.
-
Linear & Non-Linear with Custom Template: The step has a custom navigation template.
No automatic hiding or displaying occurs if is set to false when you use a template for navigation. The Previous button should be optional on the template.
-
Using the Visual Studio Designer and : The control has 5 steps, you are working on step 4, and you run the page.
When step 4 is the , then the Previous button is rendered. The Previous button is only hidden for set to when the preceding step in the history has set to false. Since step 4 is rendered first and there are no steps in the history, the Previous button is not hidden.
-
Start Step and Non-Linear Navigation: A user visits step 3 and step 4 and then step 1 which has set to .
The wizard does not add a Previous button when the is set to regardless of how the user navigates to that step.
-
Same Step In History: A user visits step 3 where is set to and the user does not commit their actions. They then click on the previous button on step 3.
The wizard control checks to see if the Previous step in the history is the "same" step that the user is currently on. If the step is the same, the wizard control looks back in the history to determine the preceding "different" step and bases the display of the Previous button and destination based on the "different step" in the history.
When the property is set to false, but the property of the parent control of is set to true, clicking on a button in the sidebar area has no effect. The sidebar area is generally displayed to provide nonlinear navigation, so if you are not using the functionality of nonlinear navigation, you may want to set the property to false.
This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.
Gets or sets a value indicating whether the user is allowed to return to the current step from a subsequent step in a collection.
2.0.0.0
Property
System.ComponentModel.Browsable(false)
System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
System.String
To be added.
The property returns a string that identifies a step in a wizard control. If a value is specified for the property, the property returns that value. If no value is specified for the property, the property returns the value of the property. If values are not specified for either the or the property, the property returns null.
Gets the name associated with a step in a control that acts as a wizard.
2.0.0.0
Property
System.ComponentModel.DefaultValue(System.Web.UI.WebControls.WizardStepType.Auto)
System.Web.UI.WebControls.WizardStepType
To be added.
Use the property to specify the type of navigation buttons to display for a step in a control. If you specify a value for this property, any steps marked as displays in a disabled state in the sidebar.
If you do not specify a value for this property, the default is WizardStepType.Auto.
The following table lists the available settings for the property and the resulting behavior of the step:
-
WizardStepType.Auto
The navigation UI that is rendered for the step is determined by the order in which the step is declared.
-
WizardStepType.Complete
The step is the last one to appear. No navigation buttons are rendered.
-
WizardStepType.Finish
The step is the final data collection step. The Finish and Previous buttons are rendered for navigation.
-
WizardStepType.Start
The step is the first one to appear. A Previous button is not rendered.
-
WizardStepType.Step
The step is any step between the Start and the Finish step. Previous and Next buttons are rendered for navigation. This step type is useful for overriding the step type.
Gets or sets the type of navigation user interface (UI) to display for a step in a control.
2.0.0.0
Property
System.ComponentModel.Localizable(true)
System.ComponentModel.DefaultValue("")
System.String
To be added.
Use the property to display a user-friendly title for a step in a control when the sidebar feature is enabled. If the property is not set and the sidebar feature is enabled, the value of the property is displayed for the sidebar button.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.
Gets or sets the title to use for a step in a control when the sidebar feature is enabled.
2.0.0.0
Property
System.ComponentModel.Browsable(false)
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)
System.Web.UI.WebControls.Wizard
To be added.
To be added.
Gets the control that is the parent of the object derived from .
2.0.0.0