ASP.NET WaitPage Framework - Pete Beech

WaitPageHelper Methods

The methods of the WaitPageHelper class are listed below. For a complete list of WaitPageHelper class members, see the WaitPageHelper Members topic.

Public Static Methods

CancelCurrentTask Cancels the current task, and signals to any interested parties, via ITaskWaiter.NotifyResultsReadyForPage, that no results are coming.
DoWait This is repeatedly called to wait for the current ITaskWaiter to finish, redirecting to the results page once the task finishes.
GetCurrentTaskResults Returns the results from the current task, if it exists. An exception is thrown if there is no current task, or the task has not completed.
RegisterDefaultWaitPageURL This function sets a default Wait Page URL which overrides the hardcoded one and the one specified in web.config. The wait page for a particular ITaskWaiter is determined in the following order: 1) The URL returned by ITaskWaiter.GetWaitPageURL 2) If this is null, then the WaitPage URL registered with the WaitPageHelper (using the RegisterDefaultWaitPageURL function) 3) If no URL has been registered with the above function, it comes from the AppSetting “DefaultWaitPageURL” in the web.config file. 4) If this AppSetting is not set, a hardcoded WaitPage URL of "~/WaitPage.aspx" is used.
RegisterTaskWaiter This function is used just after the originating page starts the task. It registers the corresponding ITaskWaiter object with the WaitPage framework. It returns true if the task was registered, and false if the taskWaiter couldn’t be registered, if, for example, another task already exists.
StartWaiting Starts the WaitPage process by displaying the redirecting to the WaitPage.
StartWaitingWithRedirectDelay This simply returns the appropriate WaitPage URL for the currently registered ITaskWaiter. It is the responsibility of the calling WebForm to perform the redirection to this URL.

Public Instance Methods

Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
ToString (inherited from Object) Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

WaitPageHelper Class | WaitPageFramework Namespace