Click or drag to resize

IWizPage Methods

The IWizPage type exposes the following members.

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