Click or drag to resize

WizPageKernel Class

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

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

The WizPageKernel type exposes the following members.

Constructors
  NameDescription
Protected methodWizPageKernel
Initializes a new instance of the WizPageKernel class
Top
Properties
  NameDescription
Public propertyAppContext
Returns the application context for the running instance.
Public propertyAutoEnterKey
Gets/Sets the value of the AutoEnterKey value.
Public propertyAvailableButtons
Returns the bitmask of available buttons
Public propertyBackCaption
The text to display on the Back button of your wizard.
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.
Public propertyContainer
Gets/Sets the container (Grouper) for this page.
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 propertyDescription
Gets/Sets the PageElement's description. The initial value is returned from the PageElementInfo.
Public propertyErrorMessage
Called by the template to get the error message after the Next button is clicked.
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.
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 propertyNextCaption
The text to display on the Next button of your wizard.
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 propertyStatusMessage
Public propertyUserData
Gets/Sets the page-to-page state data. You should consider using PageData for simpler access to UserData.
Public propertyWizard
The parent wizard object (of type WizTemplate) for this wizard page.
Top
Methods
  NameDescription
Public methodAddUserData
Wrapper method to add custom UserData entries
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
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 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.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
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 methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitPage
Called during the Page_Init method of your control. You should create any dynamic controls during this method.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
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.
Public methodOnCancel
Called when the Cancel button is clicked. You should override this method to perform any cleanup associated with your control.
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.
Public methodOnNext
Called from the template when the Next button is clicked. Override this method to respond to the button click.
Public methodOnUnload
Called when the control is about to be unloaded. You should override this method to perform any cleanup associated with your control.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
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 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 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