IWizardTemplate Interface

Get the IAppContext application context for this wizard.

Gets/sets the caption to use for the page. See also Description. By default the Caption text item for the page's PageInfo is used, but this can be overridden by setting this property. The Caption can be set programmatically as late in the page life-cycle as PreRender and therefore typically during the WizardBeforePageLoad(Object, WizardPageEventArgs) or WizardPageLoad(Object, WizardPageEventArgs) events.

The collection of WizCompletedPageInfo objects for this wizard and any previous wizards that chained to this wizard.

Gets or Sets the current page number, 1-based.

Returns the current wizard IWizPage page object.

Provides a list of name/value pairs for this wizard for viewing in the debugger. Because of the unordered nature of a Hashtable, Use DebugList to view the data in this object. For performance reasons you should not use this except for debugging.

Gets/sets the description to use for the page. See also Caption. By default the Description text item for the page's PageInfo is used, but this can be overridden by setting this property. Note that unless DescTwoPart is set, this Description is ignored and that of the current PageElementInfo is used. At this time, if the Description is to be set programmatically, it must be set quite early in the page life-cycle, typically during the WizardBeforePageLoad(Object, WizardPageEventArgs) event (the WizardPageLoad(Object, WizardPageEventArgs) event is too late).

Returns the collection of extensions attached to this wizard.

Returns the final destination wizard IWizPage page object. When moving between pages in the wizard, two pages are rendered, the page being departed, and the final detestination page (for the initial page of the wizard there is only a final destination page). At the time the page being departed is rendered, the wizard has NOT loaded the final destination page and so FinalDestinationPage will return null (at least at present). You can use IsCurrentPageFinalDestination to determine if the CurrentWizPage is the final destination page is being rendered.

Determines whether or not the IWizPage currently being rendered, the CurrentWizPage, is the final destination page. When moving between pages in the wizard, two pages are rendered, the page being departed, and the final detestination page (for the initial page of the wizard there is only a final destination page). You can use FinalDestinationPage to get the final destination page, if known by the wizard.

Determines whether or not the current page is supposed to be in design mode.

Gets the originating referrer URL if available. This can be used as the ReturnToCaller destination if no specific destination can be determined from the current URL.

The originating IWizardTemplate wizard. This will be the PageInfo either for the current wizard instance or the initial wizard instance in a series of one or more wizards chaining to other wizards.

Get the PageInfo object for this wizard.

Gets the current page stack. Page numbers are 1-based, and the first element in the array is the bottom of the stack. Note that the CurrentPage is NOT on the stack. The following stack manipulation methods are provided primarily for internal use, use with caution:

• Use PrevPage to see the top page on the stack (the last page prior to this one).
• Use PagePop to pop the previous page off the stack.
• Use PagePush(Int32) to push a new page onto the page stack.

Gets the list of pages visited during this wizard invocation. Page numbers are 1-based and the first element in the array is the first page visited. Visited pages may include pages beyond the current page in the case where a user moves forward through the wizard and then back to previously-visited pages.

Gets the source of the current post-back (if this is a post back). This can be used by wizard pages, early in their life-cycles (e.g. in their InitPage(Boolean) method), to determine if the user clicked the Next, Previous, Finish, or Cancel button.

Gets the Previous Page from saved state, 1-based. This is the top page on the PageStack.

Gets or sets the format of the wizard step caption.

Returns the UserData collection which is used to persist page data between postbacks as the user moves from page to page. Among other data, this includes the various user-entered field values from previous pages. Rather than accessing this data directly, it is recommended that you access UserData via PageData(String) which returns a WizPageData object prividing for a more structured approach.

The wizard page WizAttrs attributes.

Returns the WizardPages as a collection of PageElementInfo objects.

Gets the WizInst (wizard instance) GUID for this wizard instance. Each time a wizard is run a unique WizInst is generated. The most common use for the WizInst is to tie temporary records to a particular wizard invocation.

Generate action script for the specified action. If the specified action is set on the page then script is generated for it. If not, a null/empty string is returned.

Generate action script for the specified action. If the specified action is set on the page then script is generated for it. If not, a null/empty string is returned.

Chain to another wizard programmatically. Typically wizards are chained together in meta-data by setting the ChainsToWizard attribute and an appropriate FinishTarget. Wizard chaining allows multiple wizard pages to be glued together into, essentially, one wizard. In general the platform attempts to glue the wizards together as seamlessly as possible in order to provide the appearance to the end use of a single wizard. Note that internally this method performs a call to Navigate(String, String, String, String, NavigateAttrs, String). If more navigation control is required in programmatic chaining, use the ChainToWizard(String, String, String, String, NavigateAttrs, String) overload.

Chain to another wizard programmatically. Typically wizards are chained together in meta-data by setting the ChainsToWizard attribute and an appropriate FinishTarget. Wizard chaining allows multiple wizard pages to be glued together into, essentially, one wizard. In general the platform attempts to glue the wizards together as seamlessly as possible in order to provide the appearance to the end use of a single wizard. Note that internally this method performs a call to Navigate(String, String, String, String, NavigateAttrs, String). Generally programmatic chaining is performed using the simpler ChainToWizard(String, String) overload.

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.

Generates the query parameters required to carry wizard progress forward when chaining from the current wizard instance to another wizard instance. The parameters are properly URI encoded and start with a separating ampersand. If the current wizard was itself chained to, the parameters include the requisite information.

Gets the cloned PageInfo object for this page. If the page's PageInfo object has not net been cloned then this method clones it and sets the clone back on the page. If the page's PageInfo object has already been cloned then that object is returned. In either case the returned PageInfo object will have the ClonedByUser status. Once the page's PageInfo has been cloned and set back on the page, the cloned PageInfo object can be freely manipulated without affecting other requests by the current, or other, users.

Note that cloning the PageInfo and setting back on the page does not update any IMapper objects already set up with the original PageInfo object. However, any IMapper objects set up after the operation will use the cloned PageInfo. Performing the operation during the ApplicationPageInit event (PageInit(IAppContext, ApplicationPageArgs)) sets up the clone very early in the page life-cycle and ensure that the page's IMapper objects will use the cloned PageInfo.

Gets the page number of the specified wizard page element.

Get the specified localized text for this wizard page (however, typically GetCascadedText(IWizPage, String, String) is preferred). This method should be used only for pre-defined wizard text items found in the IDS.Wizard globalization constants.

Get the specified localized text for this wizard page (however, typically GetCascadedText(IWizPage, String, String) is preferred). Obtaining the text is a three step process:

1. Look for the text item specified by name in the PageInfo's TextItems collection,
2. if not found, look for the item specified by ids in the locale resource file,
3. if not found, use the provided defaultText.

Load IField data from the specified IMapper into the wizard's UserData for the specified instance.

This method may be called to perform programmatic navigation from a wizard extension. Typically the wizard is allowed to perform its normal cancel or finish navigation per its CancelTarget or FinishTarget, respectively. However, when programmatic navigation is required this method allows navigation to the same targets as would otherwise occur. Manual construction of the FinishTarget, in particular, can be complicated and this method takes advantage of the wizard's built-in FinishTarget construction. In addition, for cases in which the wizard may, or may not, be hosted in a popup, this method can be used to behave accordingly.

Gets the WizPageData helper class for the specified page in this wizard. Used to manage a wizard's UserData.

Pops the previous page off the PageStack. This method is provided primarily for internal use, use with caution. Use PagePush(Int32) to push a new page onto the page stack.

Pushes the specified page onto the PageStack. This method is provided primarily for internal use, use with caution. Use PagePop to pop the previous page off the stack.

Stores a text string for this wizard page. This method should be used only for pre-defined wizard text items found in the IDS.Wizard globalization constants.