This documentation is archived and is not being maintained.

WaitDialog Members

Visual Studio 2008

Pops up UI to show during a lengthy asynchronous operation when the user cannot perform any other action in the snap-in or view.

The WaitDialog type exposes the following members.

Public method WaitDialog Initializes a new instance of the WaitDialog class.

Public method CompleteDialog Completes the dialog and forces a return from ShowDialog.
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose Overloaded.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone Overloaded.
Public method ShowDialog Overloaded.
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Public method UpdateProgress Updates the progress in a single call.

Public property CanCancel Gets or sets a flag that decides whether the user can cancel this dialog.
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public property DisplayDelay Gets or sets the delay timespan for showing the dialog. Having this property helps prevent flicker for requests that are fast. For faster requests, no wait dialog is displayed.
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property MinimumDisplayTime Gets or sets the minimum span of time for which to display the dialog, even if it completes before the minimum span of time elapses.
Public property Name Gets or sets the name of the dialog.
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Public property StatusText Gets or sets the status text to show in the dialog.
Public property Title Gets or sets the title for the dialog.
Public property TotalWork Gets or sets the total work to be done before the dialog can complete. If progress cannot be determined, this property is set to 0 to show an animation.
Public property WorkProcessed Gets or sets the portion of work that has been completed.

Public event Cancel Occurs when the user clicks the cancel button. It occurs on the thread that is running the dialog.
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)