IVsFinder Interface
TOC
Collapse the table of content
Expand the table of content
The document is archived and information here might be outdated

IVsFinder Interface

Finds a text image.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in microsoft.visualstudio.textmanager.interop.dll)

[InterfaceTypeAttribute(1)] 
[GuidAttribute("D0C79C30-C06A-11D2-936C-D714766E8B50")] 
public interface IVsFinder
/** @attribute InterfaceTypeAttribute(1) */ 
/** @attribute GuidAttribute("D0C79C30-C06A-11D2-936C-D714766E8B50") */ 
public interface IVsFinder
InterfaceTypeAttribute(1) 
GuidAttribute("D0C79C30-C06A-11D2-936C-D714766E8B50") 
public interface IVsFinder

To acquire a text image:

  • QueryInterface a shell's text buffer for an IVsTextImage.

  • Use the text image implementations available through TxFactory.h.

To search an image using the finder:

  • AttachTextImage the image to search.

  • Init with the search pattern and options.

  • SetScope (optional) to limit the search to a subset of the image. This can be a number of non-contiguous regions of the image.

  • SetPosition to set the starting and/or current positions and the wrapped state of search.

  • Find.

The finder has no knowledge of hidden text (FR_Hidden). Searching only non-hidden text must be implemented by setting a span set of the visible regions. "Try match" means to test for a match at the specified position without scanning. To get a match set or a regex tag set after a find, you must pass VSFH_SetMatch. If you do not need a match set or tag set, it is more efficient to NOT pass VSFH_SetMatch.

Notes to Implementers Implemented by the environment. Instances available through the environment's global service provider.

Show:
© 2016 Microsoft