EditPoint2.ReplaceText(Object, String, Int32) Method

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Replaces the selected text with the given text.

public:
 void ReplaceText(System::Object ^ PointOrCount, System::String ^ Text, int Flags);

public:
 void ReplaceText(Platform::Object ^ PointOrCount, Platform::String ^ Text, int Flags);

void ReplaceText(winrt::Windows::Foundation::IInspectable const & PointOrCount, std::wstring const & Text, int Flags);

[System.Runtime.InteropServices.DispId(164)]
public void ReplaceText (object PointOrCount, string Text, int Flags);

[<System.Runtime.InteropServices.DispId(164)>]
abstract member ReplaceText : obj * string * int -> unit

Public Sub ReplaceText (PointOrCount As Object, Text As String, Flags As Integer)

Parameters

PointOrCount

Object

Required. Either a TextPoint object or an integer that determines the text to replace.

Text

String

Required. The text to insert.

Flags

Int32

Required. A vsEPReplaceTextOptions constant representing an editor action.

Implements

ReplaceText(Object, String, Int32)

Attributes

DispIdAttribute

Examples

Sub ReplaceTextExample()  
   Dim objTextDoc As TextDocument  
   Dim objMovePt As EditPoint  
   Dim objEditPt As EditPoint, iCtr As Integer  

   ' 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")  
   objMovePt = objTextDoc.EndPoint.CreateEditPoint  
   objEditPt = objTextDoc.StartPoint.CreateEditPoint  

   ' Insert ten lines of text.  
   For iCtr = 1 To 10  
      objEditPt.Insert("This is a test." & Chr(13))  
   Next iCtr  
   objEditPt.StartOfDocument()  
   objMovePt.EndOfDocument()  
   ' Replace all occurrences of "test" with "thing."  
   MsgBox("Replacing all text with a new string...")  
   objEditPt.ReplaceText(objMovePt, "ALL TEXT REPLACED WITH THIS SENTENCE.", vsEPReplaceTextOptions.vsEPReplaceTextAutoformat)  
End Sub  

Remarks

ReplaceText replaces the text between the edit point and PointOrCount with Text, making an attempt to preserve the locations of markers for breakpoints, named shortcuts, and so forth.