VsSearchTask VsSearchTask VsSearchTask VsSearchTask VsSearchTask Class

Definition

Base class for implementing search tasks used by search-able tool windows.

public ref class VsSearchTask : Microsoft::VisualStudio::Shell::Interop::IVsSearchTask
[Windows::Foundation::Metadata::WebHostHidden]
class VsSearchTask : Microsoft::VisualStudio::Shell::Interop::IVsSearchTask
public class VsSearchTask : Microsoft.VisualStudio.Shell.Interop.IVsSearchTask
type VsSearchTask = class
    interface IVsSearchTask
Public Class VsSearchTask
Implements IVsSearchTask
Inheritance
VsSearchTaskVsSearchTaskVsSearchTaskVsSearchTaskVsSearchTask
Derived
Implements

Constructors

VsSearchTask(UInt32, IVsSearchQuery, IVsSearchCallback) VsSearchTask(UInt32, IVsSearchQuery, IVsSearchCallback) VsSearchTask(UInt32, IVsSearchQuery, IVsSearchCallback) VsSearchTask(UInt32, IVsSearchQuery, IVsSearchCallback) VsSearchTask(UInt32, IVsSearchQuery, IVsSearchCallback)

Initializes a new instance of the VsSearchTask class.

Properties

ErrorCode ErrorCode ErrorCode ErrorCode ErrorCode

Gets or sets the error code describing the search result if the search task has completed with errors. If the task completes without errors, this property is set to zero (0).

Id Id Id Id Id

Gets the search task identifier. The task identifier is the cookie passed in the VsSearchTask(UInt32, IVsSearchQuery, IVsSearchCallback) constructor when the task was created.

SearchCallback SearchCallback SearchCallback SearchCallback SearchCallback

Gets the callback interface that needs to be called when the search is complete.

SearchQuery SearchQuery SearchQuery SearchQuery SearchQuery

Gets the search query used by the search task.

SearchResults SearchResults SearchResults SearchResults SearchResults

Gets or sets the number of search results found. Set this value appropriately as the search progresses.

TaskStatus TaskStatus TaskStatus TaskStatus TaskStatus

Gets the status of the current search. This property is set to appropriate values as the search progresses.

Methods

OnStartSearch() OnStartSearch() OnStartSearch() OnStartSearch() OnStartSearch()

Called on background threads when the search is started. Override to do task-specific search.

OnStopSearch() OnStopSearch() OnStopSearch() OnStopSearch() OnStopSearch()

Called on the UI thread when the search is stopped. Override to do task-specific stop actions.

SetTaskStatus(VSConstants+VsSearchTaskStatus) SetTaskStatus(VSConstants+VsSearchTaskStatus) SetTaskStatus(VSConstants+VsSearchTaskStatus) SetTaskStatus(VSConstants+VsSearchTaskStatus) SetTaskStatus(VSConstants+VsSearchTaskStatus)

Helper function to set the task status.

Start() Start() Start() Start() Start()

Starts the search task.

Stop() Stop() Stop() Stop() Stop()

Stops the search task.

Explicit Interface Implementations

IVsSearchTask.Status IVsSearchTask.Status IVsSearchTask.Status IVsSearchTask.Status IVsSearchTask.Status

Extension Methods

FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>)
FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>)

Microsoft internal use only.

FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>)
FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>)
IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>)

Microsoft internal use only.

Applies to