EditPoint.NextBookmark Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Moves to the location of the next bookmark in the document.

public:
 bool NextBookmark();

public:
 bool NextBookmark();

bool NextBookmark();

[System.Runtime.InteropServices.DispId(123)]
public bool NextBookmark ();

[<System.Runtime.InteropServices.DispId(123)>]
abstract member NextBookmark : unit -> bool

Public Function NextBookmark () As Boolean

Returns

Boolean

true if the insertion point moves to the next bookmark; otherwise, false.

Attributes: DispIdAttribute

Examples

Sub NextBookmarkExample(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 NextBookmarkExample(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();  
}

Remarks

The EditPoint is moved to the new location. If there are no more bookmarks, no movement occurs.

Applies to

Share via