Find.ReplaceWith Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets or sets the replacement text for a replacement operation.

public:
 property System::String ^ ReplaceWith { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ ReplaceWith { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(12)]
public string ReplaceWith { [System.Runtime.InteropServices.DispId(12)] get; [System.Runtime.InteropServices.DispId(12)] set; }

[<System.Runtime.InteropServices.DispId(12)>]
[<get: System.Runtime.InteropServices.DispId(12)>]
[<set: System.Runtime.InteropServices.DispId(12)>]
member this.ReplaceWith : string with get, set

Public Property ReplaceWith As String

Property Value

String

The text to be used in the replacement operation.

Attributes

DispIdAttribute

Examples

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