ThreadedWaitDialogHelper::StartWaitDialog Method (IVsThreadedWaitDialogFactory^, String^, ThreadedWaitDialogProgressData^, TimeSpan)
Visual Studio 2015
Show the threaded wait dialog and wire it up to receive progress updates via IProgress{ThreadedWaitDialogProgressData}and report cancellation via CancellationToken.
Assembly: Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)
public: [ExtensionAttribute] static ThreadedWaitDialogHelper::Session^ StartWaitDialog( IVsThreadedWaitDialogFactory^ dialogFactory, String^ waitCaption, ThreadedWaitDialogProgressData^ initialProgress = null, TimeSpan delayToShowDialog = null )
Parameters
- dialogFactory
-
Type:
Microsoft.VisualStudio.Shell.Interop::IVsThreadedWaitDialogFactory^
The dialog factory to use for showing the wait dialog.
- waitCaption
-
Type:
System::String^
The caption for the dialog.
- initialProgress
-
Type:
Microsoft.VisualStudio.Shell::ThreadedWaitDialogProgressData^
The initial progress data for the dialog.
- delayToShowDialog
-
Type:
System::TimeSpan
The delay before the dialog becomes visible. Resolution is limited to seconds.
Return Value
Type: Microsoft.VisualStudio.Shell::ThreadedWaitDialogHelper::Session^A Session instance that can be used to report progress to the dialog and check for user cancellation of the operation. Call IDisposable.Dispose on the returned value to dismiss the dialog.
Show: