IFinder Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Operations

Assembly:: Microsoft.VisualStudio.Text.Logic.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An object that is used to perform a variety of find operations on ITextSnapshot. Created via the IFinderFactory.

public interface class IFinder

public interface IFinder

type IFinder = interface

Public Interface IFinder

Remarks

The find & replace strings, find options and snapshot are set when the IFinder is created and cannot be changed.

Properties

FindWhat	The string being searched for.
Options	The search options.
ReplaceWith	The string used to replace the found text.
Snapshot	The snapshot searched by the finder.

Methods

FindAll()	Find all matches in the entire snapshot.
FindAll(Span)	Find all matches in `searchRange`.
FindForReplaceAll()	Find all matches in the entire snapshot.
FindForReplaceAll(Span)	Find all matches in `searchRange`.
TryFind(Int32, Span)	Try to find the first/last instance after/before `startingPosition` in the entire snapshot.
TryFind(Int32, Span, Span)	Try to find the first/last instance after/before `startingPosition` in `searchRange`.
TryFind(Span)	Try to find the first/last instance in the entire snapspshot.
TryFind(Span, Span)	Try to find the first/last instance in `searchRange`.
TryFindForReplace(Int32, Span, Span, String)	Try to find the first/last instance after/before `startingPosition` in `searchRange`. `expandedReplacePattern` is the text that should be used for the replacement (accounting for regex substitutions).
TryFindForReplace(Int32, Span, String)	Try to find the first/last instance after/before `startingPosition` in the entire snapshot. `expandedReplacePattern` is the text that should be used for the replacement (accounting for regex substitutions).
TryFindForReplace(Span, Span, String)	Try to find the first/last instance in `searchRange`. `expandedReplacePattern` is the text that should be used for the replacement (accounting for regex substitutions).
TryFindForReplace(Span, String)	Try to find the first/last instance in the entire snapspshot. `expandedReplacePattern` is the text that should be used for the replacement (accounting for regex substitutions).

Applies to