DelegateSearchTask Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Microsoft internal use only. A convenience class that let you specify the work that the search task needs to do. It is derived from VsSearchTask.
public ref class DelegateSearchTask : Microsoft::VisualStudio::Shell::VsSearchTask[Windows::Foundation::Metadata::WebHostHidden]
class DelegateSearchTask : Microsoft::VisualStudio::Shell::VsSearchTaskpublic class DelegateSearchTask : Microsoft.VisualStudio.Shell.VsSearchTasktype DelegateSearchTask = class
inherit VsSearchTaskPublic Class DelegateSearchTask
Inherits VsSearchTask- Inheritance
Constructors
| DelegateSearchTask(UInt32, IVsSearchQuery, IVsSearchCallback, Action<DelegateSearchTask>) |
Creates an instance of DelegateSearchTask. |
Properties
| ErrorCode |
The error code describing the search result, should the search task have completed with errors (Inherited from VsSearchTask) |
| Id |
The search task identifier (Inherited from VsSearchTask) |
| IsStopped |
Determines whether or not the search is stopped. |
| SearchCallback |
The callback interface that needs to be called when the search is complete (Inherited from VsSearchTask) |
| SearchQuery |
The search query used by the search task (Inherited from VsSearchTask) |
| SearchResults |
The number of search results found (Inherited from VsSearchTask) |
| TaskStatus |
The status of the current search This needs to be set to appropriate values as the search progresses (Inherited from VsSearchTask) |
Methods
| OnStartSearch() |
Handles the StartSearch event. |
| OnStopSearch() |
Called on the UI thread when the search is stopped. Override to do task-specific stop actions. Note: a search can be set to stopped state even before it's actually started Override to stop the search, and set the SearchResults appropriately so it can be reported for completion (Inherited from VsSearchTask) |
| SetTaskStatus(VSConstants+VsSearchTaskStatus) |
Helper function to set the task status (Inherited from VsSearchTask) |
| Start() |
Starts the search task (Inherited from VsSearchTask) |
| Stop() |
Stops the search task (Inherited from VsSearchTask) |
Explicit Interface Implementations
| IVsSearchTask.Status |
The task status (Inherited from VsSearchTask) |