Share via


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
System_CAPS_pubmethod WaitDialog()

Initializes a new instance of the WaitDialog class.

Properties

Name Description
System_CAPS_pubproperty CanCancel

Gets or sets a flag that decides whether the user can cancel this dialog.

System_CAPS_protproperty CanRaiseEvents

(Inherited from Component.)

System_CAPS_pubproperty Container

(Inherited from Component.)

System_CAPS_protproperty DesignMode

(Inherited from Component.)

System_CAPS_pubproperty 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.

System_CAPS_protproperty Events

(Inherited from Component.)

System_CAPS_pubproperty 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.

System_CAPS_pubproperty Name

Gets or sets the name of the dialog.

System_CAPS_pubproperty Site

(Inherited from Component.)

System_CAPS_pubproperty StatusText

Gets or sets the status text to show in the dialog.

System_CAPS_pubproperty Title

Gets or sets the title for the dialog.

System_CAPS_pubproperty 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.

System_CAPS_pubproperty WorkProcessed

Gets or sets the portion of work that has been completed.

Methods

Name Description
System_CAPS_pubmethod CompleteDialog()

Completes the dialog and forces a return from ShowDialog.

System_CAPS_pubmethod CreateObjRef(Type)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod Dispose()

(Inherited from Component.)

System_CAPS_protmethod Dispose(Boolean)

Terminates the unmanaged wait dialog.(Overrides Component.Dispose(Boolean).)

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Component.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethod GetService(Type)

(Inherited from Component.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod InitializeLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone(Boolean)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod ShowDialog()

Shows the dialog and uses the active window as the parent window.

System_CAPS_pubmethod ShowDialog(IWin32Window)

Shows the dialog modal to the current thread.

System_CAPS_pubmethod ToString()

(Inherited from Component.)

System_CAPS_pubmethod UpdateProgress(Int32, Int32, String)

Updates the progress in a single call.

Events

Name Description
System_CAPS_pubevent Cancel

Occurs when the user clicks the cancel button. It occurs on the thread that is running the dialog.

System_CAPS_pubevent 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