Export (0) Print
Expand All
ID
Top
Expand Minimize
This topic has not yet been rated - Rate this topic

MatchWholeWord Property

Visual Studio .NET 2003

Sets or returns whether the search matches whole words only.

[Visual Basic .NET]
Public Property MatchWholeWord() As Boolean
[Visual Basic 6]
Property Get MatchWholeWord() As Boolean
Property Let MatchWholeWord( _
   ByVal NewValue As Boolean _
) 
[C++]
HRESULT __stdcall get_MatchWholeWord(
   /* [out, retval] */ VARIANT_BOOL* retVal
);
HRESULT __stdcall put_MatchWholeWord(
   /* [in] */ VARIANT_BOOL NewValue
);
[C#]
public bool MatchWholeWord {get; set;}
[JScript .NET]
public function get MatchWholeWord() : Boolean
public function set MatchWholeWord(
   NewValue : Boolean
)

Parameters

NewValue
Required. Determines the type of find action to take. True means the search matches entire words only. False means the search can match partial words.

Return Value

True means the search matched entire words only. False means the search matched partial as well as entire words.

Remarks

MatchWholeWord defaults to the last global find state used.

Example

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

See Also

MatchCase Property | MatchInHiddenText Property

Applies To: Find Object

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.