IWizPage Interface |
Namespace: NetQuarry
The IWizPage type exposes the following members.
Name | Description | |
---|---|---|
AppContext |
Returns the IAppContext application context for the running instance.
| |
AutoEnterKey |
Gets/Sets the value of the AutoEnterKey value.
| |
AvailableButtons |
Returns the bitmask of available buttons
| |
BackCaption |
The text to display on the Back button of your wizard.
| |
CancelCaption |
The text to display on the Cancel button of your wizard.
The default value is the string "Cancel"
| |
CancelScript |
Called by the template to get the script to run when the Cancel button is clicked.
| |
Container |
Gets/Sets the container (Grouper) for this page.
| |
ContinueScript |
Gets/Sets the script to navigate to when the continue button is clicked.
| |
ContinueText |
Gets/Sets the text displayed AFTER the last page.
| |
Control |
Returns the UserControl of this page.
| |
Description |
Gets/Sets the page description. The default (initial) value comes from the PageElementInfo for the slot.
| |
ErrorMessage |
Called by the template to get the error message after the Next button is clicked.
| |
EventSource |
Gets/Sets the PostBack 'source' for this event.
| |
FinishCaption |
The text to display on the Finish button of your wizard.
The default value is the string "Finish".
| |
FinishScript |
Called by the template to get the script to run when the Finish button is clicked.
| |
Mapper |
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.
| |
NextCaption |
The text to display on the Next button of your wizard.
| |
PageData |
Gets the helper class for this wizard page used to manage the UserData.
| |
PageElementInfo |
Gets/Sets this wizard page's PageElementInfo.
| |
PageInfo |
The PageInfo object associated with the parent wizard.
| |
PageNumber |
Gets/Sets this control's 1-based page number in the wizard.
| |
StatusMessage | ||
UserData |
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.
| |
Wizard |
The wizard using this page.
The type is expected to be WizTemplate and implement the IWizardTemplate interface.
|
Name | Description | |
---|---|---|
AddUserData |
Wrapper method to add custom UserData entries.
| |
GetCascadedText |
Get the specified localized text for this wizard page. Obtaining the text is
a cascading five step process:
| |
GetNextPage |
Called before the next page is determined by the wizard.
If overridden, you should specifiy the next page to display in the wizard.
| |
InitPage |
Called during the Page_Init method of your control. You should create any dynamic controls during this method.
| |
OnBack |
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.
| |
OnCancel |
Called when the Cancel button is clicked. You should override this method to perform any cleanup
associated with your control.
| |
OnFinish |
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.
| |
OnNext |
Called from the template when the Next button is clicked. Override this
method to respond to the button click.
| |
OnUnload |
Called when the control is about to be unloaded. You should override this method to perform any cleanup
associated with your control.
|
Name | Description | |
---|---|---|
GetCascadedText |
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.) | |
GetMapper |
Gets the strongly typed IMapper for the wizard page.
(Defined by WizPageExtensions.) | |
GetWizPageText |
Gets the text for the specified text item, if exists, set via SetWizPageText(IWizPage, String, String).
(Defined by WizPageExtensions.) | |
SetWizPageText |
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.) |