IVsFindCancelDialog Interface

 

Use the IVsFindCancelDialog interface to launch a modeless dialog on the background thread that will allow a user to cancel a lengthy background find or find and replace operation.

Namespace:   Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop.8.0 (in Microsoft.VisualStudio.TextManager.Interop.8.0.dll)

[InterfaceTypeAttribute(1)]
[GuidAttribute("FE7C62A2-C121-4995-9EC1-561B80D2DA11")]
public interface IVsFindCancelDialog

NameDescription
System_CAPS_pubmethodCloseDialog()

Dismisses a modeless background dialog opened with LaunchDialog.

System_CAPS_pubmethodLaunchDialog()

Launches a modeless dialog on the background thread with which the user can cancel a lengthy find or replace operation

System_CAPS_pubmethodQueryDialog(Int32)

Determines whether the user of the modeless dialog on the background thread has cancelled a find or replace operation.

Use the IVsFindCancelDialog interface to launch a modeless dialog on the background thread so that a user can cancel a lengthy find or find and replace operation.

This interface is implemented by the Visual Studio environment. To use, first call the LaunchDialog method to launch the modeless dialog. Poll the dialog to see if the user has canceled the current background find operation by calling the QueryDialog method. Finally, dismiss the dialog by calling the CloseDialog method.

The environment's implementation of this interface is thread-aware, so you may call the interface methods without regard to whether your process is running on the foreground or background threads.

Notes to Implementers:

In the LaunchDialog method, launch a modeless dialog on the background thread if the caller is on the foreground thread. If the caller is on the background thread, you do not need to launch a dialog because the user will be able to cancel the find operation by clicking the stop find button.

Within QueryDialog, if the caller is on the foreground thread, query cross-thread to poll the dialog for user input.

Within CloseDialog, if the caller is on the foreground thread, close the dialog you previously opened with LaunchDialog. If the caller is on the background thread, you do not need to close the dialog because you will not have launched it on the call to LaunchDialog.

Return to top
Show: