TextDocument.MarkText Method

Article
11/19/2013

Indicates whether or not the indicated text was found in the text document and creates unnamed bookmarks wherever matching text is found.

Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Function MarkText ( _
    Pattern As String, _
    vsFindOptionsValue As Integer _
) As Boolean

bool MarkText(
    string Pattern,
    int vsFindOptionsValue
)

bool MarkText(
    [InAttribute] String^ Pattern, 
    [InAttribute] int vsFindOptionsValue
)

abstract MarkText : 
        Pattern:string * 
        vsFindOptionsValue:int -> bool

function MarkText(
    Pattern : String, 
    vsFindOptionsValue : int
) : boolean

Parameters

Pattern
Type: System.String

Required. The text pattern to find.

vsFindOptionsValue
Type: System.Int32

Optional. A vsFindOptions constant that specifies the search text options.

Return Value

Type: System.Boolean
A Boolean value true if the marked text was found in the text document, otherwise returns false.

Remarks

MarkText searches the entire text document for Pattern, automatically creating unnamed bookmarks at each occurrence of Pattern.

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.

Examples

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via