Find.MatchWholeWord Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets or sets a value indicating whether the search matches whole words only.

public:
 property bool MatchWholeWord { bool get(); void set(bool value); };

public:
 property bool MatchWholeWord { bool get(); void set(bool value); };

[System.Runtime.InteropServices.DispId(6)]
public bool MatchWholeWord { [System.Runtime.InteropServices.DispId(6)] get; [System.Runtime.InteropServices.DispId(6)] set; }

[<System.Runtime.InteropServices.DispId(6)>]
[<get: System.Runtime.InteropServices.DispId(6)>]
[<set: System.Runtime.InteropServices.DispId(6)>]
member this.MatchWholeWord : bool with get, set

Public Property MatchWholeWord As Boolean

Property Value

Boolean

true means the search matched entire words only; false means the search matched partial as well as entire words.

Attributes

DispIdAttribute

Examples

Sub MatchWholeWordExample()  
   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

MatchWholeWord defaults to the last global find state used.