The CMSWizard type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
CMSWizard |
Methods
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 | (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. (Inherited from Wizard.) | |
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 | 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.) | |
ClearCachedClientID | Sets the cached ClientID value to null. (Inherited from Control.) | |
ClearEffectiveClientIDMode | Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (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.) | |
CreateControlCollection | (Inherited from Wizard.) | |
CreateControlHierarchy | Creates the hierarchy of child controls that make up the control. (Inherited from Wizard.) | |
CreateControlStyle | (Inherited from Wizard.) | |
CreateChildControls | (Inherited from Wizard.) | |
DataBind | Binds a data source to the CompositeControl and all its child controls. (Inherited from CompositeControl.) | |
DataBind(Boolean) | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.) | |
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 | (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(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) | |
FindControl(String, Int32) | Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.) | |
Focus | Sets input focus to a control. (Inherited from Control.) | |
GetDesignModeState | (Inherited from Wizard.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetHistory | Returns a collection of WizardStepBase objects that have been accessed. (Inherited from Wizard.) | |
GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetStepType | Returns the WizardStepType value for the specified WizardStepBase object. (Inherited from Wizard.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) | |
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 | Determines if the server control holds only literal content. (Inherited from Control.) | |
LoadControlState | (Inherited from Wizard.) | |
LoadViewState | (Inherited from Wizard.) | |
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. (Inherited from Wizard.) | |
OnActiveStepChanged | Raises the ActiveStepChanged event. (Inherited from Wizard.) | |
OnBubbleEvent | (Inherited from Wizard.) | |
OnCancelButtonClick | Raises the CancelButtonClick event. (Inherited from Wizard.) | |
OnDataBinding | Raises the DataBinding event. (Inherited from Control.) | |
OnFinishButtonClick | Raises the FinishButtonClick event. (Inherited from Wizard.) | |
OnInit |
Init event handler.
(Overrides Wizard OnInit(EventArgs).) | |
OnLoad | Raises the Load event. (Inherited from Control.) | |
OnNextButtonClick | Raises the NextButtonClick event. (Inherited from Wizard.) | |
OnPreRender | Raises the PreRender event. (Inherited from Control.) | |
OnPreviousButtonClick | Raises the PreviousButtonClick event. (Inherited from Wizard.) | |
OnSideBarButtonClick | Raises the SideBarButtonClick event. (Inherited from Wizard.) | |
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. (Inherited from Wizard.) | |
RemovedControl | (Inherited from Control.) | |
Render | (Inherited from Wizard.) | |
RenderBeginTag | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderContents | Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) | |
RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) | |
RenderEndTag | Renders the HTML closing tag of the control into 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.) | |
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 | (Inherited from Wizard.) | |
SaveViewState | (Inherited from Wizard.) | |
SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) | |
SetRenderMethodDelegate | 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 | (Inherited from Wizard.) |
Extension Methods
Name | Description | |
---|---|---|
AddCssClass |
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
CallHandled |
Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page.
Returns true, if the call succeeded, otherwise returns false.
(Defined by ControlsExtensions.) | |
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetCssClasses |
Returns all CSS classes of control.
(Defined by ControlsExtensions.) | |
GetRenderedHTML |
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
HasCssClass |
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
RemoveCssClass |
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
SetCssClasses |
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.) | |
SetShortID |
Sets the short ID to the ID if available.
(Defined by ControlsExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Properties
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. (Inherited from Wizard.) | |
ActiveStepIndex | Gets or sets the index of the current WizardStepBase object. (Inherited from Wizard.) | |
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 | 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. (Inherited from Wizard.) | |
CancelButtonStyle | Gets a reference to a collection of style properties that define the appearance of the Cancel button. (Inherited from Wizard.) | |
CancelButtonText | Gets or sets the text caption that is displayed for the Cancel button. (Inherited from Wizard.) | |
CancelButtonType | Gets or sets the type of button that is rendered as the Cancel button. (Inherited from Wizard.) | |
CancelDestinationPageUrl | Gets or sets the URL that the user is directed to when they click the Cancel button. (Inherited from Wizard.) | |
CellPadding | Gets or sets the amount of space between the contents of the cell and the cell border. (Inherited from Wizard.) | |
CellSpacing | Gets or sets the amount of space between cells. (Inherited from Wizard.) | |
ClientID | Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.) | |
ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (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.) | |
DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) | |
DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.) | |
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. (Inherited from Wizard.) | |
DisplaySideBar | Gets or sets a Boolean value indicating whether to display the sidebar area on the Wizard control. (Inherited from Wizard.) | |
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. (Inherited from Wizard.) | |
FinishCompleteButtonStyle | Gets a reference to a Style object that defines the settings for the Finish button. (Inherited from Wizard.) | |
FinishCompleteButtonText | Gets or sets the text caption that is displayed for the Finish button. (Inherited from Wizard.) | |
FinishCompleteButtonType | Gets or sets the type of button that is rendered as the Finish button. (Inherited from Wizard.) | |
FinishDestinationPageUrl | Gets or sets the URL that the user is redirected to when they click the Finish button. (Inherited from Wizard.) | |
FinishNavigationTemplate | Gets or sets the template that is used to display the navigation area on the Finish step. (Inherited from Wizard.) | |
FinishPreviousButtonImageUrl | Gets or sets the URL of the image that is displayed for the Previous button on the Finish step. (Inherited from Wizard.) | |
FinishPreviousButtonStyle | Gets a reference to a Style object that defines the settings for the Previous button on the Finish step. (Inherited from Wizard.) | |
FinishPreviousButtonText | Gets or sets the text caption that is displayed for the Previous button on the Finish step. (Inherited from Wizard.) | |
FinishPreviousButtonType | Gets or sets the type of button that is rendered as the Previous button on the Finish step. (Inherited from Wizard.) | |
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. (Inherited from Wizard.) | |
HeaderTemplate | Gets or sets the template that is used to display the header area on the control. (Inherited from Wizard.) | |
HeaderText | Gets or sets the text caption that is displayed for the header area on the control. (Inherited from Wizard.) | |
Height | Gets or sets the height of the Web server control. (Inherited from WebControl.) | |
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) | |
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) | |
IdSeparator | Gets the character used to separate control identifiers. (Inherited from Control.) | |
IsEnabled | Gets a value indicating whether the control is enabled. (Inherited from WebControl.) | |
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) | |
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.) | |
LayoutTemplate | Gets or sets the custom content of the root container in a Wizard control. (Inherited from Wizard.) | |
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 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. (Inherited from Wizard.) | |
NavigationStyle | Gets a reference to a Style object that defines the settings for the navigation area on the control. (Inherited from Wizard.) | |
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.) | |
RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) | |
ShortID |
Short ID of the control.
| |
SideBarButtonStyle | Gets a reference to a Style object that defines the settings for the buttons on the sidebar. (Inherited from Wizard.) | |
SideBarStyle | Gets a reference to a Style object that defines the settings for the sidebar area on the control. (Inherited from Wizard.) | |
SideBarTemplate | Gets or sets the template that is used to display the sidebar area on the control. (Inherited from Wizard.) | |
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. (Inherited from Wizard.) | |
StartNavigationTemplate | Gets or sets the template that is used to display the navigation area on the Start step of the Wizard control. (Inherited from Wizard.) | |
StartNextButtonImageUrl | Gets or sets the URL of the image that is displayed for the Next button on the Start step. (Inherited from Wizard.) | |
StartNextButtonStyle | (Inherited from Wizard.) | |
StartNextButtonText | Gets or sets the text caption that is displayed for the Next button on the Start step. (Inherited from Wizard.) | |
StartNextButtonType | Gets or sets the type of button that is rendered as the Next button on the Start step. (Inherited from Wizard.) | |
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. (Inherited from Wizard.) | |
StepNextButtonImageUrl | Gets or sets the URL of the image that is displayed for the Next button. (Inherited from Wizard.) | |
StepNextButtonStyle | Gets a reference to the Style object that defines the settings for the Next button. (Inherited from Wizard.) | |
StepNextButtonText | Gets or sets the text caption that is displayed for the Next button. (Inherited from Wizard.) | |
StepNextButtonType | Gets or sets the type of button that is rendered as the Next button. (Inherited from Wizard.) | |
StepPreviousButtonImageUrl | Gets or sets the URL of the image that is displayed for the Previous button. (Inherited from Wizard.) | |
StepPreviousButtonStyle | Gets a reference to a Style object that defines the settings for the Previous button. (Inherited from Wizard.) | |
StepPreviousButtonText | Gets or sets the text caption that is displayed for the Previous button. (Inherited from Wizard.) | |
StepPreviousButtonType | Gets or sets the type of button that is rendered as the Previous button. (Inherited from Wizard.) | |
StepStyle | Gets a reference to a Style object that defines the settings for the WizardStep objects. (Inherited from Wizard.) | |
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.) | |
SupportsDisabledAttribute | Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Inherited from CompositeControl.) | |
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. (Inherited from Wizard.) | |
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.) | |
ViewStateMode | Gets or sets the view-state mode of this control. (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. (Inherited from Wizard.) |
Events
Name | Description | |
---|---|---|
ActiveStepChanged | Occurs when the user switches to a new step in the control. (Inherited from Wizard.) | |
CancelButtonClick | Occurs when the Cancel button is clicked. (Inherited from Wizard.) | |
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. (Inherited from Wizard.) | |
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. (Inherited from Wizard.) | |
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) | |
PreviousButtonClick | Occurs when the Previous button is clicked. (Inherited from Wizard.) | |
SideBarButtonClick | Occurs when a button in the sidebar area is clicked. (Inherited from Wizard.) | |
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
See Also