EditPoint2.PreviousBookmark Method

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Moves the edit point to the location of the previous bookmark in the document.

public:
 bool PreviousBookmark();

public:
 bool PreviousBookmark();

bool PreviousBookmark();

[System.Runtime.InteropServices.DispId(124)]
public bool PreviousBookmark ();

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

Public Function PreviousBookmark () As Boolean

Returns

Boolean

true if the edit point moves to a previous bookmark; otherwise, false.

Implements

PreviousBookmark()

Attributes

DispIdAttribute

Examples

Sub PreviousBookmarkExample(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 PreviousBookmarkExample(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

If there are no more bookmarks, the edit point is not moved.

PreviousBookmark moves the EditPoint object to the location of the first bookmark preceding the location of the active end of the EditPoint. The EditPoint is collapsed at the new location.