Share via

IVsFinder Interface

  • Article

Finds a text image.

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

Syntax

'Declaration
<GuidAttribute("D0C79C30-C06A-11D2-936C-D714766E8B50")> _
<InterfaceTypeAttribute()> _
Public Interface IVsFinder

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

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

[<GuidAttribute("D0C79C30-C06A-11D2-936C-D714766E8B50")>]
[<InterfaceTypeAttribute()>]
type IVsFinder =  interface end

public interface IVsFinder

The IVsFinder type exposes the following members.

Methods

  Name Description
Public method AttachTextImage Attached a text image.
Public method Detach Detaches a text image.
Public method Find Finds a text image within a text span.
Public method GetMatch Gets a textspan match.
Public method GetMatchedSpans Gets matched textspans.
Public method GetState Gets state.
Public method GetTaggedSpans Returns tagged textspans.
Public method Init Sets the find string.
Public method SetPosition Sets search positions
Public method SetScope Restricts search to the span set.

Top

Remarks

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.

See Also

Reference

Microsoft.VisualStudio.TextManager.Interop Namespace