TextDocument.ClearBookmarks Method

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Removes all unnamed bookmarks in the text document.

public:
 void ClearBookmarks();

public:
 void ClearBookmarks();

void ClearBookmarks();

[System.Runtime.InteropServices.DispId(122)]
public void ClearBookmarks ();

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

Public Sub ClearBookmarks ()

Attributes

DispIdAttribute

Examples

Sub ClearBookmarksExample(ByVal dte As EnvDTE.DTE)  
    Dim objTD As TextDocument  

    objTD = dte.ActiveDocument.Object  
    MsgBox("Selection: " & objTD.Selection.Mode.ToString)  
    If Not objTD.MarkText("int") Then  
        MsgBox("""int"" not found.")  
    Else  
        MsgBox("Note that unnamed bookmarks have been placed on lines _  
        containing ""int"".")  
        objTD.ClearBookmarks()  
    End If  
End Sub  

public void ClearBookmarksExample(_DTE dte)  
{  
    TextDocument td;  

    td = (TextDocument)dte.ActiveDocument.Object("");  
    MessageBox.Show ("Selection: " + td.Selection.Mode.ToString ());  
    if (td.MarkText ("int", (int)vsFindOptions.vsFindOptionsNone) ==   
    false)  
        MessageBox.Show ("\"int\" not found.");  
    else  
    {  
        MessageBox.Show ("Note that unnamed bookmarks have been placed   
        on lines containing \"int\".");  
        td.ClearBookmarks ();  
    }  
}  

Remarks

The following examples look in a document (like a text file) for the word, int. If it is found, a bookmark is placed on its line. The examples then use the ClearBookmarks method to delete the bookmarks.

To run the following example, first either create or open a document that contains the word, int.