WaitDialog Class
Pops up UI to show during a lengthy asynchronous operation when the user cannot perform any other action in the snap-in or view.
Namespace: Microsoft.ManagementConsole.Advanced
Assembly: Microsoft.ManagementConsole (in Microsoft.ManagementConsole.dll)
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
Microsoft.ManagementConsole.Advanced.WaitDialog
Syntax
public class WaitDialog : Component
public ref class WaitDialog : Component
type WaitDialog =
class
inherit Component
end
Public Class WaitDialog
Inherits Component
Constructors
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubmethod") |
WaitDialog() | Initializes a new instance of the WaitDialog class. |
Properties
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubproperty") |
CanCancel | Gets or sets a flag that decides whether the user can cancel this dialog. |
.jpeg "System_CAPS_protproperty") |
CanRaiseEvents | (Inherited from Component.) |
|
Container | (Inherited from Component.) |
|
DesignMode | (Inherited from Component.) |
|
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. |
|
Events | (Inherited from Component.) |
|
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. |
|
Name | Gets or sets the name of the dialog. |
|
Site | (Inherited from Component.) |
|
StatusText | Gets or sets the status text to show in the dialog. |
|
Title | Gets or sets the title for the dialog. |
|
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. |
|
WorkProcessed | Gets or sets the portion of work that has been completed. |
Methods
| Name | Description | |
|---|---|---|
|
CompleteDialog() | Completes the dialog and forces a return from ShowDialog. |
|
CreateObjRef(Type) | (Inherited from MarshalByRefObject.) |
|
Dispose() | (Inherited from Component.) |
.jpeg "System_CAPS_protmethod") |
Dispose(Boolean) | Terminates the unmanaged wait dialog.(Overrides Component.Dispose(Boolean).) |
|
Equals(Object) | (Inherited from Object.) |
|
Finalize() | (Inherited from Component.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetLifetimeService() | (Inherited from MarshalByRefObject.) |
|
GetService(Type) | (Inherited from Component.) |
|
GetType() | (Inherited from Object.) |
|
InitializeLifetimeService() | (Inherited from MarshalByRefObject.) |
|
MemberwiseClone() | (Inherited from Object.) |
|
MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) |
|
ShowDialog() | Shows the dialog and uses the active window as the parent window. |
|
ShowDialog(IWin32Window) | Shows the dialog modal to the current thread. |
|
ToString() | (Inherited from Component.) |
|
UpdateProgress(Int32, Int32, String) | Updates the progress in a single call. |
Events
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubevent") |
Cancel | Occurs when the user clicks the cancel button. It occurs on the thread that is running the dialog. |
|
Disposed | (Inherited from Component.) |
Remarks
Note
Call ShowDialog to show the dialog on one thread and provide status and progress on another thread.
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Microsoft.ManagementConsole.Advanced Namespace
Return to top