This documentation is archived and is not being maintained.
Wizard Members
Visual Studio 2008
Provides navigation and a user interface (UI) to collect related data across multiple steps.
The Wizard type exposes the following members.
| Name | Description | |
|---|---|---|
|
AddAttributesToRender | Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.) |
|
AddedControl | Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.) |
|
AddParsedSubObject | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.) |
|
AllowNavigationToStep | Uses a Boolean value to determine whether the ActiveStep property can be set to the WizardStepBase object that corresponds to the index that is passed in. |
|
ApplyStyle | Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.) |
|
ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) |
|
BuildProfileTree | Infrastructure. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.) |
|
ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) |
|
ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) |
|
ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) |
|
CopyBaseAttributes | Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.) |
|
CreateChildControls | Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Overrides Control::CreateChildControls().) |
|
CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Overrides Control::CreateControlCollection().) |
|
CreateControlHierarchy | Creates the hierarchy of child controls that make up the control. |
|
CreateControlStyle | Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Overrides WebControl::CreateControlStyle().) |
|
DataBind | Overloaded. Binds a data source to the invoked server control and all its child controls. |
|
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) |
|
Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) |
|
EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) |
|
EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) |
|
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
FindControl | Overloaded. Searches the current naming container for the specified server control. |
|
Focus | Sets input focus to a control. (Inherited from Control.) |
|
GetDesignModeState | Gets design-time data for a control. (Overrides Control::GetDesignModeState().) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetHistory | Returns a collection of WizardStepBase objects that have been accessed. |
|
GetStepType | Returns the WizardStepType value for the specified WizardStepBase object. |
|
GetType | Gets the type of the current instance. (Inherited from Object.) |
|
HasControls | Determines if the server control contains any child controls. (Inherited from Control.) |
|
HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) |
|
IsLiteralContent | Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.) |
|
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Overrides Control::LoadControlState(Object).) |
|
LoadViewState | Restores view-state information from a previous request that was saved with the SaveViewState method. (Overrides WebControl::LoadViewState(Object).) |
|
MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
MergeStyle | Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.) |
|
MoveTo | Sets the specified WizardStepBase-derived object as the value for the ActiveStep property of the Wizard control. |
|
OnActiveStepChanged | Raises the ActiveStepChanged event. |
|
OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Overrides Control::OnBubbleEvent(Object, EventArgs).) |
|
OnCancelButtonClick | Raises the CancelButtonClick event. |
|
OnDataBinding | Raises the DataBinding event. (Inherited from Control.) |
|
OnFinishButtonClick | Raises the FinishButtonClick event. |
|
OnInit | Raises the Init event. (Overrides Control::OnInit(EventArgs).) |
|
OnLoad | Raises the Load event. (Inherited from Control.) |
|
OnNextButtonClick | Raises the NextButtonClick event. |
|
OnPreRender | Raises the PreRender event. (Inherited from Control.) |
|
OnPreviousButtonClick | Raises the PreviousButtonClick event. |
|
OnSideBarButtonClick | Raises the SideBarButtonClick event. |
|
OnUnload | Raises the Unload event. (Inherited from Control.) |
|
OpenFile | Gets a Stream used to read a file. (Inherited from Control.) |
|
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) |
|
RecreateChildControls | Recreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl.) |
|
RegisterCommandEvents | Registers a new instance of the CommandEventHandler class for the specified IButtonControl object. |
|
RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.) |
|
Render | Writes the CompositeControl content to the specified HtmlTextWriter object, for display on the client. (Overrides CompositeControl::Render(HtmlTextWriter).) |
|
RenderBeginTag | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) |
|
RenderChildren | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.) |
|
RenderContents | Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) |
|
RenderControl | Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. |
|
RenderEndTag | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) |
|
ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) |
|
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) |
|
ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) |
|
SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Overrides Control::SaveControlState().) |
|
SaveViewState | Saves any state that was modified after the TrackViewState method was invoked. (Overrides WebControl::SaveViewState().) |
|
SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) |
|
SetRenderMethodDelegate | Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
TrackViewState | Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Overrides WebControl::TrackViewState().) |
| Name | Description | |
|---|---|---|
|
FindDataSourceControl | Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.) |
|
FindFieldTemplate | Returns the field template for the specified column within the specified control's naming container. (Defined by DynamicDataExtensions.) |
|
FindMetaTable | Returns the MetaTable object for the containing data control. (Defined by DynamicDataExtensions.) |
| Name | Description | |
|---|---|---|
|
CancelButtonID | Specifies the identifier for the Cancel button. This field is static and read-only. |
|
CancelCommandName | Retrieves the command name for the Cancel button. This field is static and read-only. |
|
CustomFinishButtonID | Retrieves the identifier for a custom Finish button. This field is static and read-only. |
|
CustomNextButtonID | Retrieves the identifier for a custom Next button. This field is static and read-only. |
|
CustomPreviousButtonID | Retrieves the identifier for a custom Previous button. This field is static and read-only. |
|
DataListID | Retrieves the identifier for the sidebar DataList collection. This field is static and read-only. |
|
FinishButtonID | Retrieves the identifier for the Finish button. This field is static and read-only. |
|
FinishPreviousButtonID | Retrieves the identifier for the Previous button on the Finish step. This field is static and read-only. |
|
MoveCompleteCommandName | Retrieves the command name that is associated with the Finish button. This field is static and read-only. |
|
MoveNextCommandName | Retrieves the command name that is associated with the Next button. This field is static and read-only. |
|
MovePreviousCommandName | Retrieves the command name that is associated with the Previous button. This field is static and read-only. |
|
MoveToCommandName | Retrieves the command name that is associated with each of the sidebar buttons. This field is static and read-only. |
|
SideBarButtonID | Retrieves the identifier that is associated with each of the sidebar buttons. This field is static and read-only. |
|
StartNextButtonID | Retrieves the identifier that is associated with the Next button on the Start step. This field is static and read-only. |
|
StepNextButtonID | Retrieves the identifier that is associated with the Next button. This field is static and read-only. |
|
StepPreviousButtonID | Retrieves the identifier that is associated with the Previous button. This field is static and read-only. |
| Name | Description | |
|---|---|---|
|
AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.) |
|
ActiveStep | Gets the step in the WizardSteps collection that is currently displayed to the user. |
|
ActiveStepIndex | Gets or sets the index of the current WizardStepBase object. |
|
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) |
|
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) |
|
Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.) |
|
BackColor | Gets or sets the background color of the Web server control. (Inherited from WebControl.) |
|
BindingContainer | Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.) |
|
BorderColor | Gets or sets the border color of the Web control. (Inherited from WebControl.) |
|
BorderStyle | Gets or sets the border style of the Web server control. (Inherited from WebControl.) |
|
BorderWidth | Gets or sets the border width of the Web server control. (Inherited from WebControl.) |
|
CancelButtonImageUrl | Gets or sets the URL of the image displayed for the Cancel button. |
|
CancelButtonStyle | Gets a reference to a collection of style properties that define the appearance of the Cancel button. |
|
CancelButtonText | Gets or sets the text caption that is displayed for the Cancel button. |
|
CancelButtonType | Gets or sets the type of button that is rendered as the Cancel button. |
|
CancelDestinationPageUrl | Gets or sets the URL that the user is directed to when they click the Cancel button. |
|
CellPadding | Gets or sets the amount of space between the contents of the cell and the cell border. |
|
CellSpacing | Gets or sets the amount of space between cells. |
|
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) |
|
ClientID | Gets the server control identifier generated by ASP.NET. (Inherited from Control.) |
|
ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) |
|
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) |
|
Controls | Gets a ControlCollection object that represents the child controls in a CompositeControl. (Inherited from CompositeControl.) |
|
ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.) |
|
ControlStyleCreated | Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.) |
|
CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.) |
|
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) |
|
DisplayCancelButton | Gets or sets a Boolean value indicating whether to display a Cancel button. |
|
DisplaySideBar | Gets or sets a Boolean value indicating whether to display the sidebar area on the Wizard control. |
|
Enabled | Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.) |
|
EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.) |
|
EnableViewState | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.) |
|
Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) |
|
FinishCompleteButtonImageUrl | Gets or sets the URL of the image that is displayed for the Finish button. |
|
FinishCompleteButtonStyle | Gets a reference to a Style object that defines the settings for the Finish button. |
|
FinishCompleteButtonText | Gets or sets the text caption that is displayed for the Finish button. |
|
FinishCompleteButtonType | Gets or sets the type of button that is rendered as the Finish button. |
|
FinishDestinationPageUrl | Gets or sets the URL that the user is redirected to when they click the Finish button. |
|
FinishNavigationTemplate | Gets or sets the template that is used to display the navigation area on the Finish step. |
|
FinishPreviousButtonImageUrl | Gets or sets the URL of the image that is displayed for the Previous button on the Finish step. |
|
FinishPreviousButtonStyle | Gets a reference to a Style object that defines the settings for the Previous button on the Finish step. |
|
FinishPreviousButtonText | Gets or sets the text caption that is displayed for the Previous button on the Finish step. |
|
FinishPreviousButtonType | Gets or sets the type of button that is rendered as the Previous button on the Finish step. |
|
Font | Gets the font properties associated with the Web server control. (Inherited from WebControl.) |
|
ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.) |
|
HasAttributes | Gets a value indicating whether the control has attributes set. (Inherited from WebControl.) |
|
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) |
|
HeaderStyle | Gets a reference to a Style object that defines the settings for the header area on the control. |
|
HeaderTemplate | Gets or sets the template that is used to display the header area on the control. |
|
HeaderText | Gets or sets the text caption that is displayed for the header area on the control. |
|
Height | Gets or sets the height of the Web server control. (Inherited from WebControl.) |
|
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) |
|
IdSeparator | Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.) |
|
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) |
|
IsEnabled | Gets a value indicating whether the control is enabled. (Inherited from WebControl.) |
|
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) |
|
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) |
|
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) |
|
NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control::ID property value. (Inherited from Control.) |
|
NavigationButtonStyle | Gets a reference to a Style object that defines the settings for the buttons in the navigation area on the control. |
|
NavigationStyle | Gets a reference to a Style object that defines the settings for the navigation area on the control. |
|
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) |
|
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) |
|
SideBarButtonStyle | Gets a reference to a Style object that defines the settings for the buttons on the sidebar. |
|
SideBarStyle | Gets a reference to a Style object that defines the settings for the sidebar area on the control. |
|
SideBarTemplate | Gets or sets the template that is used to display the sidebar area on the control. |
|
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) |
|
SkinID | Gets or sets the skin to apply to the control. (Inherited from WebControl.) |
|
SkipLinkText | Gets or sets a value that is used to render alternate text that notifies screen readers to skip the content in the sidebar area. |
|
StartNavigationTemplate | Gets or sets the template that is used to display the navigation area on the Start step of the Wizard control. |
|
StartNextButtonImageUrl | Gets or sets the URL of the image that is displayed for the Next button on the Start step. |
|
StartNextButtonStyle | Gets a reference to a Style object that defines the settings for the Next button on the Start step. |
|
StartNextButtonText | Gets or sets the text caption that is displayed for the Next button on the Start step. |
|
StartNextButtonType | Gets or sets the type of button that is rendered as the Next button on the Start step. |
|
StepNavigationTemplate | Gets or sets the template that is used to display the navigation area on any WizardStepBase-derived objects other than the Start, the Finish, or Complete step. |
|
StepNextButtonImageUrl | Gets or sets the URL of the image that is displayed for the Next button. |
|
StepNextButtonStyle | Gets a reference to the Style object that defines the settings for the Next button. |
|
StepNextButtonText | Gets or sets the text caption that is displayed for the Next button. |
|
StepNextButtonType | Gets or sets the type of button that is rendered as the Next button. |
|
StepPreviousButtonImageUrl | Gets or sets the URL of the image that is displayed for the Previous button. |
|
StepPreviousButtonStyle | Gets a reference to a Style object that defines the settings for the Previous button. |
|
StepPreviousButtonText | Gets or sets the text caption that is displayed for the Previous button. |
|
StepPreviousButtonType | Gets or sets the type of button that is rendered as the Previous button. |
|
StepStyle | Gets a reference to a Style object that defines the settings for the WizardStep objects. |
|
Style | Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.) |
|
TabIndex | Gets or sets the tab index of the Web server control. (Inherited from WebControl.) |
|
TagKey | Gets the HtmlTextWriterTag value that corresponds to the Wizard control. (Overrides WebControl::TagKey.) |
|
TagName | Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.) |
|
TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) |
|
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) |
|
ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.) |
|
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) |
|
ViewState | Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.) |
|
ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) |
|
Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) |
|
Width | Gets or sets the width of the Web server control. (Inherited from WebControl.) |
|
WizardSteps | Gets a collection containing all the WizardStepBase objects that are defined for the control. |
| Name | Description | |
|---|---|---|
|
ActiveStepChanged | Occurs when the user switches to a new step in the control. |
|
CancelButtonClick | Occurs when the Cancel button is clicked. |
|
DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) |
|
Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.) |
|
FinishButtonClick | Occurs when the Finish button is clicked. |
|
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) |
|
Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) |
|
NextButtonClick | Occurs when the Next button is clicked. |
|
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) |
|
PreviousButtonClick | Occurs when the Previous button is clicked. |
|
SideBarButtonClick | Occurs when a button in the sidebar area is clicked. |
|
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
Top
Show: