Click or drag to resize

WizPageBase Class

Provides a base class for a UserControl that is part of a wizard. You can also create a wizard PageElementInfo renderer by deriving from WizPageKernel which also implements the IWizPage interface (as required by all wizard page renderers), but does not derive from System.Web.UI.UserControl.
Inheritance Hierarchy

Namespace:  NetQuarry
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public abstract class WizPageBase : UserControl, 
	IWizPage

The WizPageBase type exposes the following members.

Constructors
  NameDescription
Public methodWizPageBase
Constructor.
Top
Properties
  NameDescription
Protected propertyAdapter
Gets the browser-specific adapter for the control.
(Inherited from Control.)
Public propertyAppContext
Returns the application context for the running instance.
Public propertyApplication
Gets the Application object for the current Web request.
(Inherited from UserControl.)
Public propertyAppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control.)
Public propertyAppRelativeVirtualPath
Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled.
(Inherited from TemplateControl.)
Public propertyAttributes
Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file.
(Inherited from UserControl.)
Public propertyAutoEnterKey
Gets/Sets the value of the AutoEnterKey value.
Protected propertyAutoHandlers Obsolete.
The AutoHandlers property has been deprecated in ASP.NET NET 2.0. It is used by generated classes and is not intended for use within your code.
(Inherited from TemplateControl.)
Public propertyAvailableButtons
Returns the bitmask of available buttons
Public propertyBackCaption
The text to display on the Back button of your wizard.
Public propertyBindingContainer
Gets the control that contains this control's data binding.
(Inherited from Control.)
Public propertyCache
Gets the Cache object that is associated with the application that contains the user control.
(Inherited from UserControl.)
Public propertyCachePolicy
Gets a reference to a collection of caching parameters for this user control.
(Inherited from UserControl.)
Public propertyCancelCaption
The text to display on the Finish button of your wizard. The default value is the string "Cancel"
Public propertyCancelScript
Called by the template to get the script to run when the finsh button is clicked.
Protected propertyChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control.)
Public propertyClientID
Gets the control ID for HTML markup that is generated by ASP.NET.
(Inherited from Control.)
Public propertyClientIDMode
Gets or sets the algorithm that is used to generate the value of the ClientID property.
(Inherited from Control.)
Protected propertyClientIDSeparator
Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control.)
Public propertyContainer
Gets/Sets the container (Grouper) for this page.
Protected propertyContext
Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control.)
Public propertyContinueScript
Gets/Sets the script to navigate to when the continue button is clicked.
Public propertyContinueText
Gets/Sets the text displayed AFTER the last page.
Public propertyControl
Returns the UserControl of this page.
Public propertyControls
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from Control.)
Public propertyDataItemContainer
Gets a reference to the naming container if the naming container implements IDataItemContainer.
(Inherited from Control.)
Public propertyDataKeysContainer
Gets a reference to the naming container if the naming container implements IDataKeysControl.
(Inherited from Control.)
Public propertyDescription
Gets/Sets the PageElement's description. The initial value is returned from the PageElementInfo.
Protected propertyDesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from Control.)
Public propertyEnableTheming
Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the TemplateControl class.
(Inherited from TemplateControl.)
Public propertyEnableViewState
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.)
Public propertyErrorMessage
Called by the template to get the error message after the Next button is clicked.
Protected propertyEvents
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control.)
Public propertyEventSource
Gets/Sets the PostBack 'source' for this event
Public propertyFinishCaption
The text to display on the Finish button of your wizard. The default value is the string "Finish"
Public propertyFinishScript
Called by the template to get the script to run when the finsh button is clicked.
Protected propertyHasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control.)
Public propertyID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control.)
Protected propertyIdSeparator
Gets the character used to separate control identifiers.
(Inherited from Control.)
Protected propertyIsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control.)
Public propertyIsPostBack
Gets a value indicating whether the user control is being loaded in response to a client postback, or if it is being loaded and accessed for the first time.
(Inherited from UserControl.)
Protected propertyIsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control.)
Protected propertyIsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from Control.)
Protected propertyLoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control.)
Public propertyMapper
The primary mapper used by this wizard page. If no mapper is used then null should be returned. The wizard will use the mapper to ensure that client-side validation script is properly configured.
Public propertyNamingContainer
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.)
Public propertyNextCaption
The text to display on the Next button of your wizard.
Public propertyPage
Gets a reference to the Page instance that contains the server control.
(Inherited from Control.)
Public propertyPageData
Gets the helper class for this wizard page used to manage a wizard's UserData.
Public propertyPageElementInfo
Gets/Sets this control's PageElementInfo
Public propertyPageInfo
Gets/Sets the PageInfo object associated with the parent wizard
Public propertyPageNumber
Gets/Sets this control's page number in the wizard.
Public propertyParent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control.)
Public propertyRenderingCompatibility
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from Control.)
Public propertyRequest
Gets the HttpRequest object for the current Web request.
(Inherited from UserControl.)
Public propertyResponse
Gets the HttpResponse object for the current Web request.
(Inherited from UserControl.)
Public propertyServer
Gets the HttpServerUtility object for the current Web request.
(Inherited from UserControl.)
Public propertySession
Gets the HttpSessionState object for the current Web request.
(Inherited from UserControl.)
Public propertySite
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control.)
Public propertySkinID
Gets or sets the skin to apply to the control.
(Inherited from Control.)
Public propertyStatusMessage
Protected propertySupportAutoEvents
Gets a value indicating whether the TemplateControl control supports automatic events.
(Inherited from TemplateControl.)
Public propertyTemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from Control.)
Public propertyTemplateSourceDirectory
Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control.)
Public propertyTrace
Gets the TraceContext object for the current Web request.
(Inherited from UserControl.)
Public propertyUniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from Control.)
Public propertyUserData
Gets/Sets the page-to-page state data.
Protected propertyViewState
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.)
Protected propertyViewStateIgnoresCase
Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control.)
Public propertyViewStateMode
Gets or sets the view-state mode of this control.
(Inherited from Control.)
Public propertyVisible
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from Control.)
Public propertyWizard
The parent wizard object (of type WizTemplate) for this wizard page.
Top
Methods
  NameDescription
Protected methodAddedControl
Called after a child control is added to the Controls collection of the Control object.
(Inherited from Control.)
Protected methodAddParsedSubObject
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.)
Public methodAddUserData
Wrapper method to add custom UserData entries
Public methodApplyStyleSheetSkin
Applies the style properties defined in the page style sheet to the control.
(Inherited from Control.)
Protected methodBuildProfileTree
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.)
Protected methodClearCachedClientID
Sets the cached ClientID value to null.
(Inherited from Control.)
Protected methodClearChildControlState
Deletes the control-state information for the server control's child controls.
(Inherited from Control.)
Protected methodClearChildState
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from Control.)
Protected methodClearChildViewState
Deletes the view-state information for all the server control's child controls.
(Inherited from Control.)
Protected methodClearEffectiveClientIDMode
Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.
(Inherited from Control.)
Protected methodConstruct
Performs design-time logic.
(Inherited from TemplateControl.)
Protected methodCreateChildControls
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.
(Inherited from Control.)
Protected methodCreateControlCollection
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from Control.)
Protected methodCreateResourceBasedLiteralControl
Accesses literal strings stored in a resource. The CreateResourceBasedLiteralControl(Int32, Int32, Boolean) method is not intended for use from within your code.
(Inherited from TemplateControl.)
Public methodDataBind
Binds a data source to the invoked server control and all its child controls.
(Inherited from Control.)
Protected methodDataBind(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.)
Protected methodDataBindChildren
Binds a data source to the server control's child controls.
(Inherited from Control.)
Public methodDesignerInitialize
Performs any initialization steps on the user control that are required by RAD designers.
(Inherited from UserControl.)
Public methodDispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from Control.)
Protected methodEnsureChildControls
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from Control.)
Protected methodEnsureID
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from Control.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodEval(String)
Evaluates a data-binding expression.
(Inherited from TemplateControl.)
Protected methodEval(String, String)
Evaluates a data-binding expression using the specified format string to display the result.
(Inherited from TemplateControl.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindControl(String)
Searches the current naming container for a server control with the specified id parameter.
(Inherited from Control.)
Protected methodFindControl(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.)
Public methodFocus
Sets input focus to a control.
(Inherited from Control.)
Protected methodFrameworkInitialize
Initializes the control that is derived from the TemplateControl class.
(Inherited from TemplateControl.)
Public methodGetCascadedText
Get the specified localized text for this wizard page. Obtaining the text is a cascading five step process:
  1. Look for the text in UserData (use SetWizPageText(IWizPage, String, String) to set),
  2. if not found, look for the text item specified by ids in the PageElementInfoTextItems collection,
  3. if not found, look for the text item specified by ids in the PageInfoTextItems collection,
  4. if not found, look for the item specified by ids in the locale resource file,
  5. if not found, use the provided defaultText.
Protected methodGetDesignModeState
Gets design-time data for a control.
(Inherited from Control.)
Protected methodGetGlobalResourceObject(String, String)
Gets an application-level resource object based on the specified ClassKey and ResourceKey properties.
(Inherited from TemplateControl.)
Protected methodGetGlobalResourceObject(String, String, Type, String)
Gets an application-level resource object based on the specified ClassKey and ResourceKey properties, object type, and property name of the resource.
(Inherited from TemplateControl.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetLocalResourceObject(String)
Gets a page-level resource object based on the specified ResourceKey property.
(Inherited from TemplateControl.)
Protected methodGetLocalResourceObject(String, Type, String)
Gets a page-level resource object based on the specified ResourceKey property, object type, and property name.
(Inherited from TemplateControl.)
Public methodGetNextPage
Called before the next page is determined by the wizard. If overridden, you should specifiy the next page to display in the wizard.
Public methodGetRouteUrl(Object)
Gets the URL that corresponds to a set of route parameters.
(Inherited from Control.)
Public methodGetRouteUrl(RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters.
(Inherited from Control.)
Public methodGetRouteUrl(String, Object)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control.)
Public methodGetRouteUrl(String, RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control.)
Public methodGetText(String)
Returns a string from this component's localized text collection.
Public methodGetText(String, String)
Returns a string from this component's localized text collection.
Public methodGetText(String, String, String)
Get localized text.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUniqueIDRelativeTo
Returns the prefixed portion of the UniqueID property of the specified control.
(Inherited from Control.)
Public methodGetUserDataString
Returns a string from the user data collection
Public methodHasControls
Determines if the server control contains any child controls.
(Inherited from Control.)
Protected methodHasEvents
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from Control.)
Public methodInitializeAsUserControl
Initializes the UserControl object that has been created declaratively. Since there are some differences between pages and user controls, this method makes sure that the user control is initialized properly.
(Inherited from UserControl.)
Public methodInitPage
Called during the Page_Init method of your control. You should create any dynamic controls during this method.
Protected methodIsLiteralContent
Determines if the server control holds only literal content.
(Inherited from Control.)
Public methodLoadControl(String)
Loads a Control object from a file based on a specified virtual path.
(Inherited from TemplateControl.)
Public methodLoadControl(Type, Object)
Loads a Control object based on a specified type and constructor parameters.
(Inherited from TemplateControl.)
Protected methodLoadControlState
Restores control-state information from a previous page request that was saved by the SaveControlState method.
(Inherited from Control.)
Public methodLoadTemplate
Obtains an instance of the ITemplate interface from an external file.
(Inherited from TemplateControl.)
Protected methodLoadViewState
Restores the view-state information from a previous user control request that was saved by the SaveViewState method.
(Inherited from UserControl.)
Public methodMapPath
Assigns a virtual file path, either absolute or relative, to a physical file path.
(Inherited from UserControl.)
Protected methodMapPathSecure
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAbortTransaction
Raises the AbortTransaction event.
(Inherited from TemplateControl.)
Public methodOnBack
Called from the template when the Back button is clicked. Override this method if you want to capture any changes to your page before the wizard moves back.
Protected methodOnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from Control.)
Public methodOnCancel
Called when the Cancel button is clicked. You should override this method to perform any cleanup associated with your control.
Protected methodOnCommitTransaction
Raises the CommitTransaction event.
(Inherited from TemplateControl.)
Protected methodOnDataBinding
Raises the DataBinding event.
(Inherited from Control.)
Protected methodOnError
Raises the Error event.
(Inherited from TemplateControl.)
Public methodOnFinish
Called when the Finish button is clicked. The template calls this method when the Next button on the last page of the wizard is clicked.
Protected methodOnInit
Raises the Init event.
(Inherited from UserControl.)
Protected methodOnLoad
Raises the Load event.
(Inherited from Control.)
Public methodOnNext
Called from the template when the Next button is clicked. Override this method to respond to the button click.
Protected methodOnPreRender
Raises the PreRender event.
(Inherited from Control.)
Public methodOnUnload
Called when the control is about to be unloaded. You should override this method to perform any cleanup associated with your control.
Protected methodOnUnload(EventArgs)
Raises the Unload event.
(Inherited from Control.)
Protected methodOpenFile
Gets a Stream used to read a file.
(Inherited from Control.)
Public methodParseControl(String)
Parses an input string into a Control object on the Web Forms page or user control.
(Inherited from TemplateControl.)
Public methodParseControl(String, Boolean)
Parses an input string into a Control object on the ASP.NET Web page or user control.
(Inherited from TemplateControl.)
Protected methodRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from Control.)
Public methodReadStringResource
Reads a string resource. The ReadStringResource method is not intended for use from within your code.
(Inherited from TemplateControl.)
Protected methodRemovedControl
Called after a child control is removed from the Controls collection of the Control object.
(Inherited from Control.)
Protected methodRender
Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from Control.)
Protected methodRenderChildren
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.)
Public methodRenderControl(HtmlTextWriter)
Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from Control.)
Protected methodRenderControl(HtmlTextWriter, ControlAdapter)
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
(Inherited from Control.)
Protected methodResolveAdapter
Gets the control adapter responsible for rendering the specified control.
(Inherited from Control.)
Public methodResolveClientUrl
Gets a URL that can be used by the browser.
(Inherited from Control.)
Public methodResolveUrl
Converts a URL into one that is usable on the requesting client.
(Inherited from Control.)
Protected methodSaveControlState
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from Control.)
Protected methodSaveViewState
Saves any user control view-state changes that have occurred since the last page postback.
(Inherited from UserControl.)
Protected methodSetDesignModeState
Sets design-time data for a control.
(Inherited from Control.)
Public methodSetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from Control.)
Protected methodSetStringResourcePointer
Sets a pointer to a string resource. The SetStringResourcePointer(Object, Int32) method is used by generated classes and is not intended for use from within your code.
(Inherited from TemplateControl.)
Public methodTestDeviceFilter
Returns a Boolean value indicating whether a device filter applies to the HTTP request.
(Inherited from TemplateControl.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Protected methodTrackViewState
Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the ViewState property.
(Inherited from Control.)
Protected methodWriteUTF8ResourceString
Writes a resource string to an HtmlTextWriter control. The WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) method is used by generated classes and is not intended for use from within your code.
(Inherited from TemplateControl.)
Protected methodXPath(String)
Evaluates an XPath data-binding expression.
(Inherited from TemplateControl.)
Protected methodXPath(String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution.
(Inherited from TemplateControl.)
Protected methodXPath(String, String)
Evaluates an XPath data-binding expression using the specified format string to display the result.
(Inherited from TemplateControl.)
Protected methodXPath(String, String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and the specified format string to display the result.
(Inherited from TemplateControl.)
Protected methodXPathSelect(String)
Evaluates an XPath data-binding expression and returns a node collection that implements the IEnumerable interface.
(Inherited from TemplateControl.)
Protected methodXPathSelect(String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and returns a node collection that implements the IEnumerable interface.
(Inherited from TemplateControl.)
Top
Events
  NameDescription
Public eventAbortTransaction
Occurs when a user ends a transaction.
(Inherited from TemplateControl.)
Public eventCommitTransaction
Occurs when a transaction completes.
(Inherited from TemplateControl.)
Public eventDataBinding
Occurs when the server control binds to a data source.
(Inherited from Control.)
Public eventDisposed
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.)
Public eventError
Occurs when an unhandled exception is thrown.
(Inherited from TemplateControl.)
Public eventInit
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from Control.)
Public eventLoad
Occurs when the server control is loaded into the Page object.
(Inherited from Control.)
Public eventPreRender
Occurs after the Control object is loaded but prior to rendering.
(Inherited from Control.)
Public eventUnload
Occurs when the server control is unloaded from memory.
(Inherited from Control.)
Top
Fields
  NameDescription
Protected field_revealText
Specifies whether or not the page is in developer RevealText mode.
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Public Extension MethodFindControlRecursive
Recursively search the control hierarchy for the specified control and below for a control with the specified ID and return that control, if found. If not found, null is returned.
(Defined by EAPCtrlUtils.)
Public Extension MethodGetCascadedText
Gets the text for the specified text item. This is obtained by calling GetCascadedText(IWizPage, String, String) and follows the multi-level override scheme defined there. Note that text set via SetWizPageText(IWizPage, String, String) is highest precedence.
(Defined by WizPageExtensions.)
Public Extension MethodGetMapper
Gets the strongly typed IMapper for the wizard page.
(Defined by WizPageExtensions.)
Public Extension MethodGetWizPageText
Gets the text for the specified text item, if exists, set via SetWizPageText(IWizPage, String, String).
(Defined by WizPageExtensions.)
Public Extension MethodHasVisibleControls
Determines whether or not the control has any visible controls in its controls collection.
(Defined by EAPCtrlUtils.)
Public Extension MethodReplaceWith
Replace this control in its parent's Controls collection, with the specified replacement. If either control is null, no replacement is performed.
(Defined by EAPCtrlUtils.)
Public Extension MethodSetWizPageText
Sets localized text for the specified wizard page for this wizard instance only. Note that setting text on a PageInfo or PageElementInfo object is generally GLOBAL in nature and affects other application sessions, including seesions for other users, due to how pages are cached.
(Defined by WizPageExtensions.)
Top
See Also