WindowSearchCustomFilter Class

Definition

Namespace:

Microsoft.VisualStudio.PlatformUI

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Represents a base class from which users can derive classes to implement advanced search filters for use by the search control for window search.

public ref class WindowSearchCustomFilter : Microsoft::VisualStudio::PlatformUI::WindowSearchFilter, Microsoft::VisualStudio::Shell::Interop::IVsWindowSearchCustomFilter

[Windows::Foundation::Metadata::WebHostHidden]
class WindowSearchCustomFilter : Microsoft::VisualStudio::PlatformUI::WindowSearchFilter, Microsoft::VisualStudio::Shell::Interop::IVsWindowSearchCustomFilter

public class WindowSearchCustomFilter : Microsoft.VisualStudio.PlatformUI.WindowSearchFilter, Microsoft.VisualStudio.Shell.Interop.IVsWindowSearchCustomFilter

type WindowSearchCustomFilter = class
    inherit WindowSearchFilter
    interface IVsWindowSearchCustomFilter
    interface IVsWindowSearchFilter

Public Class WindowSearchCustomFilter
Inherits WindowSearchFilter
Implements IVsWindowSearchCustomFilter

Inheritance

Object

WindowSearchFilter

WindowSearchCustomFilter

Implements

IVsWindowSearchCustomFilter IVsWindowSearchFilter

Remarks

Search filters appear as push buttons in the search control’s popup.

Simple filters such as those implemented by WindowSearchSimpleFilter automatically append the filter token (FilterField:DefaultFilterValue) to the search control text.

This class is used to implement advanced filtering of the search control text, since the user has full control over the search field and the selection to be set in the search control after the filter is applied.

Custom filters are used to avoid adding multiple filter tokens with the same field. Custom filters are also used to select the filter value if the caret position in the search control is already within a filter token.

Constructors

WindowSearchCustomFilter(String, String)

Creates a new instance of a search filter with an apply-filter method for use by the search control for window search.

Properties

DisplayText	Gets or sets the display text for the search filter (Inherited from WindowSearchFilter)
Tooltip	Gets or sets the tooltip text for the search filter (Inherited from WindowSearchFilter)

Methods

ApplyFilter(String, Int32, Int32)

Override this method in derived classes to provide specific implementation for the custom filter, by manipulating the search text from the search control and changing the selection as needed.