Click or drag to resize

IWizPage Interface

Defines a common interface for a UserControl that is part of an IWizardTemplate.

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

The IWizPage type exposes the following members.

Properties
  NameDescription
Public propertyAppContext
Returns the IAppContext 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 Cancel 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 Cancel 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 page description. The default (initial) value comes from the PageElementInfo for the slot.
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 Finish 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. The mapper object must implement the IMapper interface.
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 the UserData.
Public propertyPageElementInfo
Gets/Sets this wizard page's PageElementInfo.
Public propertyPageInfo
The PageInfo object associated with the parent wizard.
Public propertyPageNumber
Gets/Sets this control's 1-based page number in the wizard.
Public propertyStatusMessage
Public propertyUserData
Gets/Sets the page-to-page state data. It is recommended that you manage the IWizardTemplateUserData using the PageData method which provides for more structured access.
Public propertyWizard
The wizard using this page. The type is expected to be WizTemplate and implement the IWizardTemplate interface.
Top
Methods
  NameDescription
Public methodAddUserData
Wrapper method to add custom UserData entries.
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 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 methodInitPage
Called during the Page_Init method of your control. You should create any dynamic controls during this method.
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.
Top
Extension Methods
  NameDescription
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