IVsFinder Interface

 

Finds a text image.

Namespace:   Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

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

NameDescription
System_CAPS_pubmethodAttachTextImage(Object)

Attaches a text image.

System_CAPS_pubmethodDetach()

Detaches a text image.

System_CAPS_pubmethodFind(UInt32, TextSpan[], UInt32)

Finds a text image within a text span.

System_CAPS_pubmethodGetMatch(TextSpan[])

Gets a textspan match.

System_CAPS_pubmethodGetMatchedSpans(IVsTextSpanSet)

Gets matched textspans.

System_CAPS_pubmethodGetState(Int32, UInt32, UInt32)

Gets state.

System_CAPS_pubmethodGetTaggedSpans(IVsTextSpanSet)

Returns tagged textspans.

System_CAPS_pubmethodInit(UInt32, String, Int32, UInt32)

Sets the find string.

System_CAPS_pubmethodSetPosition(UInt32, TextAddress)

Sets search positions

System_CAPS_pubmethodSetScope(IVsTextSpanSet)

Restricts search to the span set.

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.

Return to top
Show: