WizardPageEventArgs Class

Full constructor.

Gets/sets the context of the current bulk operation, if any. If this event is part of a bulk operation, this is the context of that bulk operation. If this event is not part of a bulk operation, this context will be null.

An optional, developer-specific error message. This will be logged to the Devlog and xot_request_log, but only displayed in user error messages when the user is identified as IsDeveloper.

Sets the extention's error message for this event.

Options used to specify additional characteristics about an exception.

Gets/Sets the event that is currently executing.

Gets whether or not the associated WizardPage is the final destination of the current operation. To understand what this means it is important to understand the basic mechanism for inter-page movement within a wizard. When moving from page X to page Y in the wizard, the wizard must first load page X in order to receive the posted-back state and values, only once page X has been loaded and posted-back to can page Y be loaded. That page Y is the FinalDestination page whereas page X is not. In the case of loading the initial page, there is no page X receiving page and only page Y is loaded (and is the FinalDestination page).

Gets the PageElementInfo descriptor for the page element hosting the current WizardPage. If the current item is hosted in a IWizContainer (e.g. a WizGrouper) then the host's associated PageElementInfo will be returned. Otherwise the PageElementInfo associated with the current WizardPage will be returned.

The result is suitable as a target for navigation. Only elements in a WizardPage slot are navigable. For elements in a WizardGrouper slot, you must navigate to that element's host WizardPage element and so this identifies that element.

Gets/sets the proposed next page number. During a WizardNext event or WizardPrev this can be modified to cause the wizard to navigate to a different page. Note that use of NextPageName, for readability and maintainability reasons, is generally preferred.

Gets/sets the name of the proposed next page. During a WizardNext event or WizardPrev this can be modified to cause the wizard to navigate to a different page. Setting e.NextPageName = name; is functionally equivalent to e.NextPage = e.Wizard.GetPageNumber(name); but, for readability and maintainability reasons, generally preferred over use of NextPage.

Gets/Sets the result to return from the event.

The IWizardTemplate object itself.

Gets/sets the current wizard page.

Sets the extention's result code and error message for this event. The result code is set to ExtResultsExtResults.Cancel.

Determines whether the specified Object is equal to the current Object.

Sets the extention's result code and error message for this event. The result code is set to Error. Use Error(String, String, ExceptionOptions) to include an additional developer message and/or options.

Sets the extention's result code and error message for this event with an optional developer-specific error message and options. The result code is set to Error.

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

Serves as a hash function for a particular type.

Gets the Type of the current instance.

Creates a shallow copy of the current Object.

Returns a String that represents the current Object.

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.