VsSearchTask VsSearchTask VsSearchTask VsSearchTask VsSearchTask Class

Definition

VsSearchTask can be used as base class for implementing search-able toolwindows

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)

Constructor

Properties

ErrorCode ErrorCode ErrorCode ErrorCode ErrorCode

The error code describing the search result, should the search task have completed with errors

Id Id Id Id Id

The search task identifier

SearchCallback SearchCallback SearchCallback SearchCallback SearchCallback

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

SearchQuery SearchQuery SearchQuery SearchQuery SearchQuery

The search query used by the search task

SearchResults SearchResults SearchResults SearchResults SearchResults

The number of search results found

TaskStatus TaskStatus TaskStatus TaskStatus TaskStatus

The status of the current search This needs to be 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. Set the SearchResults to indicate the number of results found so far. Call the SearchCallback on ReportProgress to report progress (if progress is supported) and call it on ReportComplete when the search is completed (with or without errors). Set the TaskStatus appropriately when done to Completed/Error. During the search, TaskStatus can be periodically checked if the search task was Stopped.

OnStopSearch() OnStopSearch() OnStopSearch() OnStopSearch() 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

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

The task 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