IVsThreadedWaitDialog3 Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Implemented by the Visual Studio shell. This interface allows a modal dialog to be displayed on a background thread so that the IDE appears responsive even when the foreground thread is busy with an extended operation. You can get this interface through SVsThreadedWaitDialogFactory. This dialog differs from IVsThreadedWaitDialog in that it can have a progress and cancel button at the same time. It also supports progress with an accurate percentage.

public interface class IVsThreadedWaitDialog3 : Microsoft::VisualStudio::Shell::Interop::IVsThreadedWaitDialog2

public interface class IVsThreadedWaitDialog3 : Microsoft::VisualStudio::Shell::Interop::IVsThreadedWaitDialog2

__interface IVsThreadedWaitDialog3 : Microsoft::VisualStudio::Shell::Interop::IVsThreadedWaitDialog2

[System.Runtime.InteropServices.Guid("E92E3159-2381-4179-A500-9676DEE38896")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsThreadedWaitDialog3 : Microsoft.VisualStudio.Shell.Interop.IVsThreadedWaitDialog2

[<System.Runtime.InteropServices.Guid("E92E3159-2381-4179-A500-9676DEE38896")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsThreadedWaitDialog3 = interface
    interface IVsThreadedWaitDialog2

Public Interface IVsThreadedWaitDialog3
Implements IVsThreadedWaitDialog2

Derived

Microsoft.VisualStudio.Shell.Interop.IVsThreadedWaitDialog4

Attributes

GuidAttribute InterfaceTypeAttribute

Implements

IVsThreadedWaitDialog2

Remarks

This interface is safe to access from any thread.

Methods

EndWaitDialog(Int32)	Stops the wait dialog.
HasCanceled(Boolean)	Determines whether the dialog has been canceled.
StartWaitDialog(String, String, String, Object, String, Int32, Boolean, Boolean)	Determines whether StartWaitDialog(Ex) has actually started a dialog.If StartWaitDialog (or StartWaitDialogEx) is called multiple times without calling EndWaitDialog, only the first will start the dialog. Subsequent calls will just be no-ops. This makes it difficult to determine how often a call site caused the dialog to show. pfStarted will be set to true if the call to StartWaitDialogEx started the wait dialog (or started the timer to show the dialog).
StartWaitDialogWithCallback(String, String, String, Object, String, Boolean, Int32, Boolean, Int32, Int32, IVsThreadedWaitDialogCallback)	Starts a wait dialog with a callback.
StartWaitDialogWithPercentageProgress(String, String, String, Object, String, Boolean, Int32, Int32, Int32)	Starts a wait dialog that shows progress.
UpdateProgress(String, String, String, Int32, Int32, Boolean, Boolean)	Updates the progress of the wait dialog.

Extension Methods

EndWaitDialog(IVsThreadedWaitDialog2)

Closes the wait dialog.