EditPoint Usage Example

Visual Studio add-ins are deprecated in Visual Studio 2013. You should upgrade your add-ins to VSPackage extensions. For more information about upgrading, see FAQ: Converting Add-ins to VSPackage Extensions.

The following example creates a TextDocument object, adds some text to it, and then demonstrates some EditPoint object functionality.

Example

Description

These functions are one-based for character offsets, whereas the IVsTextView and similar interfaces are zero-based. EditPoint is one-based because it is designed to support VB automation.

To run this example, create a Visual Studio Add-in project and in the wizard specify that it should create a Tools menu item. When you build and run the add-in, click the relevant command on the Tools menu to run the code.

Code

[Visual Basic]

Public Sub Exec(ByVal commandName As String, ByVal executeOption As vsCommandExecOption, ByRef varIn As Object, ByRef varOut As Object, ByRef handled As Boolean) Implements IDTCommandTarget.Exec
    handled = False
    If executeOption = vsCommandExecOption.vsCommandExecOptionDoDefault Then
        If commandName = "EditPoint.Connect.EditPoint" Then
            EditPointExample1(CType(_applicationObject, DTE))
            handled = True
            Exit Sub
        End If
    End If
End Sub
Sub EditPointExample1(ByVal dte As DTE)
    Dim objTextDoc As TextDocument
    Dim objEditPt As EditPoint, iCtr As Integer

    ' Create a new text file.
    applicationObject.ItemOperations.NewFile("General\Text File")

    ' Get a handle to the new document and create an EditPoint.
    objTextDoc = applicationObject.ActiveDocument.Object("TextDocument")
    objEditPt = objTextDoc.StartPoint.CreateEditPoint

    ' Insert ten lines of text.
    For iCtr = 1 To 10
        objEditPt.Insert("This is a test." & Chr(13))
    Next iCtr

    ' Replace the eighth word on the third line with a new word.
    objEditPt.StartOfDocument()
    objEditPt.LineDown(3)
    objEditPt.WordRight(3)
    objEditPt.Delete(4)
    objEditPt.Insert("raid")

    ' Indent a line.
    objEditPt.LineDown(2)
    objEditPt.StartOfLine()
    objEditPt.Indent()

    ' Set some bookmarks.
    objEditPt.LineDown(1)
    ' Set the first bookmark.
    objEditPt.SetBookmark()
    ' Set the second bookmark on the next line.
    objEditPt.LineDown(1)
    objEditPt.SetBookmark()
    ' Go back to the first bookmark.
    objEditPt.PreviousBookmark()
    ' Add some text there.
    objEditPt.Insert("BOOKMARK 1: ")
    ' Do the same thing at the next bookmark.
    objEditPt.NextBookmark()
    objEditPt.Insert("BOOKMARK 2: ")

    ' Print the current line and character offset in the buffer. 
    MsgBox("Line and offset: " & objEditPt.Line, _
    objEditPt.LineCharOffset())

    ' Capitalize the third word of the second line.
    objEditPt.StartOfDocument()
    objEditPt.LineDown(2)
    objEditPt.WordRight(3)
    objEditPt.ChangeCase(4, vsCaseOptions.vsCaseOptionsCapitalize)

    ' Remove the spaces between the words.
    objEditPt.DeleteWhitespace(vsWhitespaceOptions. _
    vsWhitespaceOptionsHorizontal)
End Sub

Using System.Windows.Forms;

public void EditPointExample1( DTE dte ) 
{ 
    TextDocument objTextDoc = null; 
    EditPoint objEditPt = null; int iCtr = 0; 

    // Create a new text file.
    applicationObject.ItemOperations.NewFile( @"General\Text File",
 "", "{00000000-0000-0000-0000-000000000000}" ); 

    // Get a handle to the new document and create an EditPoint.
    objTextDoc = ( ( EnvDTE.TextDocument )(
 applicationObject.ActiveDocument.Object( "TextDocument" ) ) ); 
    objEditPt = objTextDoc.StartPoint.CreateEditPoint(); 

    // Insert ten lines of text.
    for ( iCtr=1; iCtr<=10; iCtr++ ) 
    { 
        objEditPt.Insert( "This is a test." + "\n"); 
    } 

    // Replace the eighth word on the third line with a new word.
    objEditPt.StartOfDocument(); 
    objEditPt.LineDown( 3 ); 
    objEditPt.WordRight( 3 ); 
    objEditPt.Delete( 4 ); 
    objEditPt.Insert( "raid" ); 
    
    // Indent a line.
    objEditPt.LineDown( 2 ); 
    objEditPt.StartOfLine(); 
    objEditPt.Indent( null, 1 ); 

    // Set some bookmarks.
    objEditPt.LineDown( 1 ); 
    // Set the first bookmark.
    objEditPt.SetBookmark(); 
    // Set the second bookmark on the next line.
    objEditPt.LineDown( 1 ); 
    objEditPt.SetBookmark(); 
    // Go back to the first bookmark.
    objEditPt.PreviousBookmark(); 
    // Add some text there.
    objEditPt.Insert( "BOOKMARK 1: " ); 
    // Do the same thing at the next bookmark.
    objEditPt.NextBookmark(); 
    objEditPt.Insert( "BOOKMARK 2: " ); 
    // Print the current line and character offset in the buffer. 
    MessageBox.Show( "Line and offset: " + objEditPt.Line); 

    // Capitalize the third word of the second line.
   objEditPt.StartOfDocument(); 
    objEditPt.LineDown( 2 ); 
    objEditPt.WordRight( 3 ); 
    objEditPt.ChangeCase( 4, vsCaseOptions.vsCaseOptionsCapitalize ); 

    // Remove the spaces between the words.
    objEditPt.DeleteWhitespace( vsWhitespaceOptions.vsWhitespaceOptionsHorizontal ); 
}

See Also

Reference

EditPoint

EditPoint2

TextPoint

TextDocument