Home
About
Testimonials
Demos
Download
Documentation
Forum
Development
Class Finder
Tutorials
Class Docs
API Manual
Wiki
Namespace:
System.Web.UI.WebControls
Inheritance:
TComponent
»
TApplicationComponent
»
TControl
»
TWebControl
»
TWizard
Properties
|
Events
|
Methods
|
Derived classes
|
All classes
Properties
Name
Type
Description
AccessKey
string
the access key of the control. (inherited from
TWebControl
)
ActiveStep
TWizardStep
the currently active wizard step.
ActiveStepIndex
integer
the zero-based index of the active wizard step.
Adapter
TControlAdapter
control adapter. (inherited from
TControl
)
R
AllowChildControls
boolean
whether body contents are allowed for this control. (inherited from
TControl
)
R
Application
TApplication
current application instance. (inherited from
TApplicationComponent
)
R
Attributes
TAttributeCollection
Returns the list of custom attributes. (inherited from
TControl
)
BackColor
string
the background color of the control. (inherited from
TWebControl
)
BorderColor
string
the border color of the control. (inherited from
TWebControl
)
BorderStyle
string
the border style of the control. (inherited from
TWebControl
)
BorderWidth
string
the border width of the control. (inherited from
TWebControl
)
R
CancelButtonStyle
TWizardNavigationButtonStyle
the style for the cancel button.
CancelDestinationUrl
string
the URL that the browser will be redirected to if the cancel button in the wizard is clicked.
P
ChildControlsCreated
boolean
whether child controls have been created. (inherited from
TControl
)
R
ClientID
string
Returns the client ID of the control. (inherited from
TControl
)
P
ControlStage
integer
Gets the lifecycle step the control is currently at. (inherited from
TControl
)
R
Controls
TControlCollection
the child control collection. (inherited from
TControl
)
CssClass
string
the css class of the control. (inherited from
TWebControl
)
CustomData
mixed
Returns custom data associated with this control. (inherited from
TControl
)
Display
TDisplayStyle
display style of the control, default is TDisplayStyle::Fixed. (inherited from
TWebControl
)
EnableTheming
boolean
whether theming is enabled for this control. (inherited from
TControl
)
EnableViewState
boolean
whether viewstate is enabled. (inherited from
TControl
)
Enabled
boolean
Returns a value indicating whether the control is enabled. (inherited from
TControl
)
R
FinishCompleteButtonStyle
TWizardNavigationButtonStyle
the style for the complete button in the finish wizard step.
FinishDestinationUrl
string
the URL that the browser will be redirected to if the wizard finishes.
R
FinishNavigation
TWizardNavigationContainer
container of the finish navigation.
FinishNavigationTemplate
ITemplate
navigation template for the finish step.
R
FinishPreviousButtonStyle
TWizardNavigationButtonStyle
the style for the previous button in the start wizard step.
R
Font
TFont
the font of the control. (inherited from
TWebControl
)
ForeColor
string
the foreground color of the control. (inherited from
TWebControl
)
R
HasAdapter
boolean
whether there is an adapter for this control. (inherited from
TControl
)
R
HasAttributes
boolean
whether the control has custom attributes. (inherited from
TControl
)
R
HasChildInitialized
boolean
true if the child control has been initialized. (inherited from
TControl
)
R
HasControls
boolean
whether the control has child controls. (inherited from
TControl
)
R
HasInitialized
boolean
true if the onInit event has raised. (inherited from
TControl
)
R
HasLoaded
boolean
true if the onLoad event has raised. (inherited from
TControl
)
R
HasLoadedPostData
boolean
true if the control has loaded post data. (inherited from
TControl
)
R
HasPreRendered
boolean
true if onPreRender event has raised. (inherited from
TControl
)
R
HasStyle
boolean
whether the control has defined any style information. (inherited from
TWebControl
)
R
Header
TPanel
container of the wizard header.
R
HeaderStyle
TPanelStyle
the style for the header.
HeaderTemplate
ITemplate
template for wizard header.
HeaderText
string
header text.
Height
string
the height of the control. (inherited from
TWebControl
)
RP
History
TStack
history containing step indexes that were navigated before.
ID
string
Returns the id of the control. (inherited from
TControl
)
R
MultiView
TMultiView
Returns the multiview that holds the wizard steps.
R
NamingContainer
TControl
the naming container of this control. (inherited from
TControl
)
R
NavigationButtonStyle
TStyle
the style common for all navigation buttons.
R
NavigationStyle
TPanelStyle
the style for the navigation panel.
Page
TPage
the page that contains this control. (inherited from
TControl
)
R
Parent
TControl
the parent of this control. (inherited from
TControl
)
R
Request
THttpRequest
the current user request. (inherited from
TApplicationComponent
)
R
Response
THttpResponse
the response. (inherited from
TApplicationComponent
)
R
Service
IService
the current service. (inherited from
TApplicationComponent
)
R
Session
THttpSession
user session. (inherited from
TApplicationComponent
)
ShowCancelButton
boolean
whether to display a cancel button in each wizard step.
ShowSideBar
boolean
whether to display a side bar that contains links to wizard steps.
R
SideBar
TPanel
container of the wizard side bar.
R
SideBarButtonStyle
TStyle
the style for the buttons displayed in the side bar.
R
SideBarStyle
TPanelStyle
the style for the side bar.
SideBarTemplate
ITemplate
template for the side bar.
SkinID
string
the skin ID of this control, '' if not set. (inherited from
TControl
)
R
SourceTemplateControl
TTemplateControl
the control whose template is loaded from some external storage, such as file, db, and whose template ultimately contains this control. (inherited from
TControl
)
R
StartNavigation
TWizardNavigationContainer
container of the start navigation.
StartNavigationTemplate
ITemplate
navigation template for the start step.
R
StartNextButtonStyle
TWizardNavigationButtonStyle
the style for the next button in the start wizard step.
R
StepContent
TPanel
container of the wizard step content.
R
StepNavigation
TWizardNavigationContainer
container of the step navigation.
StepNavigationTemplate
ITemplate
navigation template for internal steps.
R
StepNextButtonStyle
TWizardNavigationButtonStyle
the style for the next button in each internal wizard step.
R
StepPreviousButtonStyle
TWizardNavigationButtonStyle
the style for the previous button in the start wizard step.
R
StepStyle
TPanelStyle
the style for each internal wizard step.
Style
TStyle
the object representing the css style of the control. (inherited from
TWebControl
)
TabIndex
integer
the tab index of the control. (inherited from
TWebControl
)
RP
TagName
string
tag name for the wizard.
TemplateControl
TTemplateControl
the control whose template contains this control. (inherited from
TControl
)
ToolTip
string
the tooltip of the control. (inherited from
TWebControl
)
R
UniqueID
string
Returns a unique ID that identifies the control in the page hierarchy. (inherited from
TControl
)
UseDefaultLayout
boolean
whether to use default layout to arrange side bar and the rest wizard components.
R
User
IUser
information about the current user. (inherited from
TApplicationComponent
)
Visible
boolean
Checks if a control is visible. (inherited from
TControl
)
Width
string
the width of the control. (inherited from
TWebControl
)
R
WizardSteps
TWizardStepCollection
collection of wizard steps.
Events
Name
Description
OnActiveStepChanged
Raises
OnActiveStepChanged
event.
OnCancelButtonClick
Raises
OnCancelButtonClick
event.
OnCompleteButtonClick
Raises
OnCompleteButtonClick
event.
OnDataBinding
Raises 'OnDataBinding' event. (inherited from
TControl
)
OnInit
Creates the child controls of the wizard.
OnLoad
This method is invoked when the control enters 'OnLoad' stage. (inherited from
TControl
)
OnNextButtonClick
Raises
OnNextButtonClick
event.
OnPreRender
This method is invoked when the control enters 'OnPreRender' stage. (inherited from
TControl
)
OnPreviousButtonClick
Raises
OnPreviousButtonClick
event.
OnSideBarButtonClick
Raises
OnSideBarButtonClick
event.
OnUnload
This method is invoked when the control enters 'OnUnload' stage. (inherited from
TControl
)
Methods
Name
Description
P
addAttributesToRender
Adds attribute name-value pairs to renderer. (inherited from
TWebControl
)
addParsedObject
Adds TWizardStep objects into step collection.
P
addToPostDataLoader
Add controls implementing IPostBackDataHandler to post data loaders. (inherited from
TControl
)
addedControl
Adds a control into the child collection of the control. (inherited from
TControl
)
addedWizardStep
Adds a wizard step to the multiview.
P
allowNavigationToPreviousStep
whether navigation to the previous step is allowed.
P
allowNavigationToStep
whether navigation to the specified step is allowed.
P
applyControlProperties
Applies various properties to the components of wizard.
P
applyHeaderProperties
Applies properties to the wizard header.
P
applyNavigationProperties
Apply properties to various navigation panels.
P
applySideBarProperties
Applies properties to the wizard sidebar.
P
applyStepContentProperties
Applies properties to the wizard step content.
applyStyleSheetSkin
Applies a stylesheet skin to a control. (inherited from
TControl
)
attachEventHandler
Attaches an event handler to an event. (inherited from
TComponent
)
autoBindProperty
Sets up the binding between a property (or property path) and an expression. (inherited from
TControl
)
P
autoDataBindProperties
Auto databinding properties of the control. (inherited from
TControl
)
bindProperty
Sets up the binding between a property (or property path) and an expression. (inherited from
TControl
)
broadcastEvent
Broadcasts an event. (inherited from
TControl
)
bubbleEvent
Handles bubbled events.
canGetProperty
Determines whether a property can be read. (inherited from
TComponent
)
canSetProperty
Determines whether a property can be set. (inherited from
TComponent
)
P
clearChildState
Clears up the child state data. (inherited from
TControl
)
P
clearControlState
Clears a controlstate value. (inherited from
TControl
)
clearNamingContainer
Resets the control as a naming container. (inherited from
TControl
)
clearStyle
Removes all style data. (inherited from
TWebControl
)
clearViewState
Clears a viewstate value. (inherited from
TControl
)
S
convertUniqueIdToClientId
Converts a unique ID to a client ID. (inherited from
TControl
)
copyBaseAttributes
Copies basic control attributes from another control. (inherited from
TWebControl
)
createChildControls
Creates child controls within the wizard.
P
createControlCollection
Creates a control collection object that is to be used to hold child controls . (inherited from
TControl
)
P
createFinishNavigation
Creates finish navigation panel.
P
createHeader
Creates the wizard header.
P
createNavigation
Creates navigation panel.
P
createSideBar
Creates the wizard side bar.
P
createStartNavigation
Creates start navigation panel.
P
createStepContent
Creates wizard step content.
P
createStepNavigation
Creates step navigation panel.
P
createStyle
Creates a style object to be used by the control. (inherited from
TWebControl
)
createdOnTemplate
This method is invoked after the component is instantiated by a template. (inherited from
TComponent
)
dataBind
Performs the databinding for this control. (inherited from
TControl
)
P
dataBindChildren
Databinding child controls. (inherited from
TControl
)
P
dataBindProperties
Databinding properties of the control. (inherited from
TControl
)
dataListItemCommand
Event handler for sidebar datalist's OnItemCommand event.
dataListItemDataBound
Event handler for sidebar datalist's OnItemDataBound event.
detachEventHandler
Detaches an existing event handler. (inherited from
TComponent
)
ensureChildControls
Ensures child controls are created. (inherited from
TControl
)
evaluateExpression
Evaluates a PHP expression in the context of this control. (inherited from
TComponent
)
evaluateStatements
Evaluates a list of PHP statements. (inherited from
TComponent
)
findControl
Finds a control by ID path within the current naming container. (inherited from
TControl
)
findControlsByID
Finds all child and grand-child controls with the specified ID. (inherited from
TControl
)
findControlsByType
Finds all child and grand-child controls that are of the specified type. (inherited from
TControl
)
focus
Sets input focus to this control. (inherited from
TControl
)
getAttribute
attribute value, null if attribute does not exist. (inherited from
TControl
)
P
getControlState
Returns a controlstate value. (inherited from
TControl
)
getEventHandlers
Returns the list of attached event handlers for an event. (inherited from
TComponent
)
P
getPreviousStepIndex
Determines the index of the previous step based on history.
getRegisteredObject
Returns the named registered object. (inherited from
TControl
)
P
getStepType
Determines the type of the specified wizard step.
getSubProperty
Evaluates a property path. (inherited from
TComponent
)
getViewState
Returns a viewstate value. (inherited from
TControl
)
hasAttribute
whether the named attribute exists. (inherited from
TControl
)
hasEvent
Determines whether an event is defined. (inherited from
TComponent
)
hasEventHandler
whether an event has been attached one or several handlers. (inherited from
TComponent
)
hasProperty
Determines whether a property is defined. (inherited from
TComponent
)
P
initRecursive
Performs the Init step for the control and all its child controls. (inherited from
TControl
)
P
isDescendentOf
if the control is a descendent (parent, parent of parent, etc. (inherited from
TControl
)
isObjectRegistered
whether an object has been registered with the name @see registerObject. (inherited from
TControl
)
P
loadRecursive
Performs the Load step for the control and all its child controls. (inherited from
TControl
)
loadState
This method is invoked right after the control has loaded its state. (inherited from
TControl
)
P
loadStateRecursive
Loads state (viewstate and controlstate) into a control and its children. (inherited from
TControl
)
P
preRenderRecursive
Performs the PreRender step for the control and all its child controls. (inherited from
TControl
)
publishAsset
Publishes a private asset and gets its URL. (inherited from
TApplicationComponent
)
publishFilePath
Publishes a file or directory and returns its URL. (inherited from
TApplicationComponent
)
P
raiseBubbleEvent
Invokes the parent's bubbleEvent method. (inherited from
TControl
)
raiseEvent
Raises an event. (inherited from
TComponent
)
registerObject
Registers an object by a name. (inherited from
TControl
)
removeAttribute
Removes the named attribute. (inherited from
TControl
)
removedControl
Removes a control from the child collection of the control. (inherited from
TControl
)
removedWizardStep
Removes a wizard step from the multiview.
render
Renders the wizard.
renderBeginTag
Renders the openning tag for the control (including attributes) . (inherited from
TWebControl
)
renderChildren
Renders the children of the control. (inherited from
TControl
)
renderContents
Renders the body content enclosed between the control tag. (inherited from
TWebControl
)
renderControl
Renders the control. (inherited from
TControl
)
renderEndTag
Renders the closing tag for the control . (inherited from
TWebControl
)
P
requiresControlsRecreation
Indicates the wizard needs to recreate all child controls.
P
reset
Clears up everything within the wizard.
saveState
Saves the current active step index into history.
P
saveStateRecursive
Saves all control state (viewstate and controlstate) as a collection. (inherited from
TControl
)
setAttribute
Sets a custom control attribute. (inherited from
TControl
)
P
setControlState
Sets a controlstate value. (inherited from
TControl
)
setSubProperty
Sets a value to a property path. (inherited from
TComponent
)
setViewState
Sets a viewstate value. (inherited from
TControl
)
trackViewState
Sets a value indicating whether we should keep data in viewstate. (inherited from
TControl
)
P
traverseChildControls
Traverse the whole control hierarchy rooted at this control. (inherited from
TControl
)
unbindProperty
Breaks the binding between a property (or property path) and an expression. (inherited from
TControl
)
P
unloadRecursive
Performs the Unload step for the control and all its child controls. (inherited from
TControl
)
unregisterObject
Unregisters an object by name. (inherited from
TControl
)
wizardStepsChanged
Updates the sidebar datalist if any.
Derived classes