EditPoint.SetBookmark Method

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Sets an unnamed bookmark on the current line in the buffer.

public:
 void SetBookmark();

public:
 void SetBookmark();

void SetBookmark();

[System.Runtime.InteropServices.DispId(121)]
public void SetBookmark ();

[<System.Runtime.InteropServices.DispId(121)>]
abstract member SetBookmark : unit -> unit

Public Sub SetBookmark ()

Attributes

DispIdAttribute

Examples

Sub SetBookmarkExample(ByVal dte As DTE2)  

    ' Create a new text document.  
    dte.ItemOperations.NewFile()  

    ' Create an EditPoint at the start of the new document.  
    Dim doc As TextDocument = _  
        CType(dte.ActiveDocument.Object("TextDocument"), TextDocument)  
    Dim point As EditPoint = doc.StartPoint.CreateEditPoint  
    Dim i As Integer  

    ' Insert ten lines of text.  
    For i = 1 To 10  
        point.Insert("This is a test." & vbCrLf)  
    Next  

    point.StartOfDocument()  

    ' Set a bookmark on each of the first two lines.  
    point.SetBookmark()  
    point.LineDown(1)  
    point.SetBookmark()  

    ' Insert text at each bookmark and then clear each bookmark.  
    point.PreviousBookmark()  
    point.Insert("BOOKMARK 1: ")  
    point.ClearBookmark()  
    point.NextBookmark()  
    point.Insert("BOOKMARK 2: ")  
    point.ClearBookmark()  

End Sub  

public void SetBookmarkExample(DTE2 dte)  
{  
    // Create a new text document.  
    dte.ItemOperations.NewFile(@"General\Text File", "", _  
        Constants.vsViewKindPrimary);  

    // Create an EditPoint at the start of the new document.  
    TextDocument doc = _  
        (TextDocument)dte.ActiveDocument.Object("TextDocument");  
    EditPoint point = doc.StartPoint.CreateEditPoint();  

    // Insert ten lines of text.  
    for (int i = 1; i <= 10; ++i)  
        point.Insert("This is a test.\n");  

    point.StartOfDocument();  

    // Set a bookmark on each of the first two lines.  
    point.SetBookmark();  
    point.LineDown(1);  
    point.SetBookmark();  

    // Insert text at each bookmark and then clear each bookmark.  
    point.PreviousBookmark();  
    point.Insert("BOOKMARK 1: ");  
    point.ClearBookmark();  
    point.NextBookmark();  
    point.Insert("BOOKMARK 2: ");  
    point.ClearBookmark();  
}