Find.Execute Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.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.

Performs a search based on the options set for the Find object.

public:
 EnvDTE::vsFindResult Execute();

public:
 EnvDTE::vsFindResult Execute();

EnvDTE::vsFindResult Execute();

[System.Runtime.InteropServices.DispId(17)]
public EnvDTE.vsFindResult Execute ();

[<System.Runtime.InteropServices.DispId(17)>]
abstract member Execute : unit -> EnvDTE.vsFindResult

Public Function Execute () As vsFindResult

Returns

vsFindResult

A vsFindResult constant.

Attributes: DispIdAttribute

Examples

Sub ExecuteExample()  
   Dim objTextDoc As TextDocument  
   Dim objEditPt As EditPoint  
   Dim iCtr As Integer  
   Dim objFind As Find  

   ' Create a new text file.  
   DTE.ItemOperations.NewFile("General\Text File")  

   ' Get a handle to the new document and create an EditPoint.  
   objTextDoc = DTE.ActiveDocument.Object("TextDocument")  
   objEditPt = objTextDoc.StartPoint.CreateEditPoint  
   objFind = objTextDoc.DTE.Find  

   ' Insert ten lines of text.  
   For iCtr = 1 To 10  
      objEditPt.Insert("This is a test." & Chr(13))  
   Next iCtr  

   ' Set the find options.  
   objFind.Action = vsFindAction.vsFindActionReplaceAll  
   objFind.Backwards = False  
   objFind.FilesOfType = "*.txt"  
   objFind.FindWhat = "test"  
   objFind.KeepModifiedDocumentsOpen = True  
   objFind.MatchCase = False  
   objFind.MatchInHiddenText = False  
   objFind.MatchWholeWord = True  
   objFind.PatternSyntax = vsFindPatternSyntax.vsFindPatternSyntaxLiteral  
   objFind.ReplaceWith = "NEW THING"  
   objFind.ResultsLocation = vsFindResultsLocation.vsFindResultsNone  
   objFind.SearchPath = "c:\temp"  
   objFind.SearchSubfolders = False  
   objFind.Target = vsFindTarget.vsFindTargetCurrentDocument  
   ' Perform the Find operation.  
   objFind.Execute()  
End Sub

Remarks

If the search operation is asynchronous, such as Find All, then the FindDone event occurs when the operation completes. It does not occur with any other Find or Replace operation as Find All is the only asynchronous Find operation.

Applies to