System.Web.UI.WebControls.Wizard Members

The members of System.Web.UI.WebControls.Wizard are listed below.

See Also: Inherited members from System.Web.UI.WebControls.CompositeControl

Public Constructors

Initializes a new instance of the System.Web.UI.WebControls.Wizard class.

Public Fields

static readonly
CancelCommandNamestring.

Retrieves the command name for the Cancel button. This field is static and read-only.

static readonly
MoveCompleteCommandNamestring.

Retrieves the command name that is associated with the Finish button. This field is static and read-only.

static readonly
MoveNextCommandNamestring.

Retrieves the command name that is associated with the Next button. This field is static and read-only.

static readonly
MovePreviousCommandNamestring.

Retrieves the command name that is associated with the Previous button. This field is static and read-only.

static readonly
MoveToCommandNamestring.

Retrieves the command name that is associated with each of the sidebar buttons. This field is static and read-only.

Protected Fields

static readonly
CancelButtonIDstring.

Specifies the identifier for the Cancel button. This field is static and read-only.

static readonly
CustomFinishButtonIDstring.

Retrieves the identifier for a custom Finish button. This field is static and read-only.

static readonly
CustomNextButtonIDstring.

Retrieves the identifier for a custom Next button. This field is static and read-only.

static readonly
CustomPreviousButtonIDstring.

Retrieves the identifier for a custom Previous button. This field is static and read-only.

static readonly
DataListIDstring.

Retrieves the identifier for the sidebar System.Web.UI.WebControls.DataList collection. This field is static and read-only.

static readonly
FinishButtonIDstring.

Retrieves the identifier for the Finish button. This field is static and read-only.

static readonly
FinishPreviousButtonIDstring.

Retrieves the identifier for the Previous button on the WizardStepType.Finish step. This field is static and read-only.

static readonly
SideBarButtonIDstring.

Retrieves the identifier that is associated with each of the sidebar buttons. This field is static and read-only.

static readonly
StartNextButtonIDstring.

Retrieves the identifier that is associated with the Next button on the WizardStepType.Start step. This field is static and read-only.

static readonly
StepNextButtonIDstring.

Retrieves the identifier that is associated with the Next button. This field is static and read-only.

static readonly
StepPreviousButtonIDstring.

Retrieves the identifier that is associated with the Previous button. This field is static and read-only.

Public Properties

[read-only]
ActiveStepWizardStepBase.

Gets the step in the Wizard.WizardSteps collection that is currently displayed to the user.

ActiveStepIndexint.

Gets or sets the index of the current System.Web.UI.WebControls.WizardStepBase object.

CancelButtonImageUrlstring.

Gets or sets the URL of the image displayed for the Cancel button.

[read-only]
CancelButtonStyleStyle.

Gets a reference to a collection of style properties that define the appearance of the Cancel button.

CancelButtonTextstring.

Gets or sets the text caption that is displayed for the Cancel button.

CancelButtonTypeButtonType.

Gets or sets the type of button that is rendered as the Cancel button.

CancelDestinationPageUrlstring.

Gets or sets the URL that the user is directed to when they click the Cancel button.

CellPaddingint.

Gets or sets the amount of space between the contents of the cell and the cell border.

CellSpacingint.

Gets or sets the amount of space between cells.

DisplayCancelButtonbool.

Gets or sets a Boolean value indicating whether to display a Cancel button.

DisplaySideBarbool.

Gets or sets a Boolean value indicating whether to display the sidebar area on the System.Web.UI.WebControls.Wizard control.

FinishCompleteButtonImageUrlstring.

Gets or sets the URL of the image that is displayed for the Finish button.

[read-only]
FinishCompleteButtonStyleStyle.

Gets a reference to a System.Web.UI.WebControls.Style object that defines the settings for the Finish button.

FinishCompleteButtonTextstring.

Gets or sets the text caption that is displayed for the Finish button.

FinishCompleteButtonTypeButtonType.

Gets or sets the type of button that is rendered as the Finish button.

FinishDestinationPageUrlstring.

Gets or sets the URL that the user is redirected to when they click the Finish button.

FinishNavigationTemplateSystem.Web.UI.ITemplate.

Gets or sets the template that is used to display the navigation area on the WizardStepType.Finish step.

FinishPreviousButtonImageUrlstring.

Gets or sets the URL of the image that is displayed for the Previous button on the WizardStepType.Finish step.

[read-only]
FinishPreviousButtonStyleStyle.

Gets a reference to a System.Web.UI.WebControls.Style object that defines the settings for the Previous button on the WizardStepType.Finish step.

FinishPreviousButtonTextstring.

Gets or sets the text caption that is displayed for the Previous button on the WizardStepType.Finish step.

FinishPreviousButtonTypeButtonType.

Gets or sets the type of button that is rendered as the Previous button on the WizardStepType.Finish step.

[read-only]
HeaderStyleTableItemStyle.

Gets a reference to a System.Web.UI.WebControls.Style object that defines the settings for the header area on the control.

HeaderTemplateSystem.Web.UI.ITemplate.

Gets or sets the template that is used to display the header area on the control.

HeaderTextstring.

Gets or sets the text caption that is displayed for the header area on the control.

[read-only]
NavigationButtonStyleStyle.

Gets a reference to a System.Web.UI.WebControls.Style object that defines the settings for the buttons in the navigation area on the control.

[read-only]
NavigationStyleTableItemStyle.

Gets a reference to a System.Web.UI.WebControls.Style object that defines the settings for the navigation area on the control.

[read-only]
SideBarButtonStyleStyle.

Gets a reference to a System.Web.UI.WebControls.Style object that defines the settings for the buttons on the sidebar.

[read-only]
SideBarStyleTableItemStyle.

Gets a reference to a System.Web.UI.WebControls.Style object that defines the settings for the sidebar area on the control.

SideBarTemplateSystem.Web.UI.ITemplate.

Gets or sets the template that is used to display the sidebar area on the control.

SkipLinkTextstring.

Gets or sets a value that is used to render alternate text that notifies screen readers to skip the content in the sidebar area.

StartNavigationTemplateSystem.Web.UI.ITemplate.

Gets or sets the template that is used to display the navigation area on the WizardStepType.Start step of the System.Web.UI.WebControls.Wizard control.

StartNextButtonImageUrlstring.

Gets or sets the URL of the image that is displayed for the Next button on the WizardStepType.Start step.

[read-only]
StartNextButtonStyleStyle.

Gets a reference to a System.Web.UI.WebControls.Style object that defines the settings for the Next button on the WizardStepType.Start step.

StartNextButtonTextstring.

Gets or sets the text caption that is displayed for the Next button on the WizardStepType.Start step.

StartNextButtonTypeButtonType.

Gets or sets the type of button that is rendered as the Next button on the WizardStepType.Start step.

StepNavigationTemplateSystem.Web.UI.ITemplate.

Gets or sets the template that is used to display the navigation area on any System.Web.UI.WebControls.WizardStepBase-derived objects other than the WizardStepType.Start, the WizardStepType.Finish, or WizardStepType.Complete step.

StepNextButtonImageUrlstring.

Gets or sets the URL of the image that is displayed for the Next button.

[read-only]
StepNextButtonStyleStyle.

Gets a reference to the System.Web.UI.WebControls.Style object that defines the settings for the Next button.

StepNextButtonTextstring.

Gets or sets the text caption that is displayed for the Next button.

StepNextButtonTypeButtonType.

Gets or sets the type of button that is rendered as the Next button.

StepPreviousButtonImageUrlstring.

Gets or sets the URL of the image that is displayed for the Previous button.

[read-only]
StepPreviousButtonStyleStyle.

Gets a reference to a System.Web.UI.WebControls.Style object that defines the settings for the Previous button.

StepPreviousButtonTextstring.

Gets or sets the text caption that is displayed for the Previous button.

StepPreviousButtonTypeButtonType.

Gets or sets the type of button that is rendered as the Previous button.

[read-only]
StepStyleTableItemStyle.

Gets a reference to a System.Web.UI.WebControls.Style object that defines the settings for the System.Web.UI.WebControls.WizardStep objects.

[read-only]
WizardStepsWizardStepCollection.

Gets a collection containing all the System.Web.UI.WebControls.WizardStepBase objects that are defined for the control.

Protected Properties

Public Methods

GetHistory() : ICollection

Returns a collection of System.Web.UI.WebControls.WizardStepBase objects that have been accessed.

GetStepType(WizardStepBase, int) : WizardStepType

Returns the System.Web.UI.WebControls.WizardStepType value for the specified System.Web.UI.WebControls.WizardStepBase object.

MoveTo(WizardStepBase)

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

Protected Methods

AllowNavigationToStep(int) : bool

Uses a Boolean value to determine whether the Wizard.ActiveStep property can be set to the System.Web.UI.WebControls.WizardStepBase object that corresponds to the index that is passed in.

override
CreateChildControls()

Creates child controls.

override
CreateControlCollection() : System.Web.UI.ControlCollection

Creates control collection.

CreateControlHierarchy()

Creates the hierarchy of child controls that make up the control.

override
CreateControlStyle() : Style

Creates control style.

override
GetDesignModeState() : IDictionary

Gets the design mode state.

override
LoadControlState(object)

Restores control state information.

override
LoadViewState(object)

Loads view-state information.

OnActiveStepChanged(object, EventArgs)

Raises the Wizard.ActiveStepChanged event.

override
OnBubbleEvent(object, EventArgs) : bool

Determines whether the event for the server control is passed up the page’s user interface server control hierarchy.

OnCancelButtonClick(EventArgs)

Raises the Wizard.CancelButtonClick event.

OnFinishButtonClick(WizardNavigationEventArgs)

Raises the Wizard.FinishButtonClick event.

override
OnInit(EventArgs)

Raises the Init event.

OnNextButtonClick(WizardNavigationEventArgs)

Raises the Wizard.NextButtonClick event.

OnPreviousButtonClick(WizardNavigationEventArgs)

Raises the Wizard.PreviousButtonClick event.

OnSideBarButtonClick(WizardNavigationEventArgs)

Raises the Wizard.SideBarButtonClick event.

RegisterCommandEvents(IButtonControl)

Registers a new instance of the System.Web.UI.WebControls.CommandEventHandler class for the specified System.Web.UI.WebControls.IButtonControl object.

override
Render(System.Web.UI.HtmlTextWriter)

Renders the control to the specified writer.

override
SaveControlState() : object

Save the control state.

override
SaveViewState() : object

Saves the view state.

override
TrackViewState()

Tracks view state.

Public Events

ActiveStepChanged

Occurs when the user switches to a new step in the control.

CancelButtonClick

Occurs when the Cancel button is clicked.

FinishButtonClick

Occurs when the Finish button is clicked.

NextButtonClick

Occurs when the Next button is clicked.

PreviousButtonClick

Occurs when the Previous button is clicked.

SideBarButtonClick

Occurs when a button in the sidebar area is clicked.