Share via

EditPoint.ReplaceText Method

  • Article

Replaces the selected text with the given text.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Sub ReplaceText ( _
    PointOrCount As Object, _
    Text As String, _
    Flags As Integer _
)

void ReplaceText(
    Object PointOrCount,
    string Text,
    int Flags
)

void ReplaceText(
    [InAttribute] Object^ PointOrCount, 
    [InAttribute] String^ Text, 
    [InAttribute] int Flags
)

abstract ReplaceText : 
        PointOrCount:Object * 
        Text:string * 
        Flags:int -> unit

function ReplaceText(
    PointOrCount : Object, 
    Text : String, 
    Flags : int
)

Parameters

  • PointOrCount
    Type: System.Object

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

Remarks

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

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

.NET Framework Security

See Also

Reference

EditPoint Interface

EnvDTE Namespace