DelegateSearchTask Class

Visual Studio 2015
 

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.

Namespace:   Microsoft.VisualStudio.PlatformUI
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

System.Object
  Microsoft.VisualStudio.Shell.VsSearchTask
    Microsoft.VisualStudio.PlatformUI.DelegateSearchTask

public class DelegateSearchTask : VsSearchTask

NameDescription
System_CAPS_pubpropertyErrorCode

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).(Inherited from VsSearchTask.)

System_CAPS_pubpropertyId

Gets the search task identifier. The task identifier is the cookie passed in the VsSearchTask constructor when the task was created.(Inherited from VsSearchTask.)

System_CAPS_pubpropertyIsStopped

Determines whether or not the search is stopped.

System_CAPS_protpropertySearchCallback

Gets the callback interface that needs to be called when the search is complete.(Inherited from VsSearchTask.)

System_CAPS_pubpropertySearchQuery

Gets the search query used by the search task.(Inherited from VsSearchTask.)

System_CAPS_pubpropertySearchResults

Gets or sets the number of search results found. Set this value appropriately as the search progresses.(Inherited from VsSearchTask.)

System_CAPS_pubpropertyTaskStatus

Gets the status of the current search. This property is set to appropriate values as the search progresses.(Inherited from VsSearchTask.)

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnStartSearch()

Handles the StartSearch event.(Overrides VsSearchTask.OnStartSearch().)

System_CAPS_protmethodOnStopSearch()

Called on the UI thread when the search is stopped. Override to do task-specific stop actions.(Inherited from VsSearchTask.)

System_CAPS_protmethodSetTaskStatus(VSConstants.VsSearchTaskStatus)

Helper function to set the task status.(Inherited from VsSearchTask.)

System_CAPS_pubmethodStart()

Starts the search task.(Inherited from VsSearchTask.)

System_CAPS_pubmethodStop()

Stops the search task.(Inherited from VsSearchTask.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: