How to: Search for Text in Documents

Applies to
The information in this topic applies only to the specified Visual Studio Tools for Office projects and versions of Microsoft Office. Project type Document-level projects Application-level projects Microsoft Office version Word 2003 Word 2007 For more information, see Features Available by Application and Project Type.

The Find object is a member of both the Selection and the Range objects, and you can use either one to search for text in Microsoft Office Word documents. The replace command is an extension of the find command. For information about replacing text in documents, see How to: Search for and Replace Text in Documents.

Using a Selection Object

When you use a Selection object to find text, any search criteria you specify are applied only against currently selected text. If the Selection is an insertion point, then the document is searched. When the item is found that matches the search criteria, it is automatically selected.

It is important to note that the Find criteria are cumulative, which means that criteria are added to previous search criteria. Clear formatting from previous searches by using the ClearFormatting method prior to the search.

To find text using a Selection object

1. Assign a search string to a variable.

   Dim findText As String = "find me"
   

   object findText = "find me";
   

2. Clear formatting from previous searches.

   Application.Selection.Find.ClearFormatting()
   

   Application.Selection.Find.ClearFormatting();
   

3. Execute the search and display a message box with the results.

   If Application.Selection.Find.Execute(findText) = True Then
       MessageBox.Show("Text found.")
   Else
       MessageBox.Show("The text could not be located.")
   End If
   

   if (Application.Selection.Find.Execute(ref findText,
       ref missing, ref missing, ref missing, ref missing, ref missing, ref missing,
       ref missing, ref missing, ref missing, ref missing, ref missing, ref missing, 
       ref missing, ref missing)) 
   { 
       MessageBox.Show("Text found.");
   } 
   else
   { 
       MessageBox.Show("The text could not be located.");
   } 
   

The following example shows the complete method.

Private Sub SelectionFind()
    Dim findText As String = "find me"

    Application.Selection.Find.ClearFormatting()

    If Application.Selection.Find.Execute(findText) = True Then
        MessageBox.Show("Text found.")
    Else
        MessageBox.Show("The text could not be located.")
    End If 
End Sub

private void SelectionFind() 
{ 
    object findText = "find me";

    Application.Selection.Find.ClearFormatting();

    if (Application.Selection.Find.Execute(ref findText,
        ref missing, ref missing, ref missing, ref missing, ref missing, ref missing,
        ref missing, ref missing, ref missing, ref missing, ref missing, ref missing, 
        ref missing, ref missing)) 
    { 
        MessageBox.Show("Text found.");
    } 
    else
    { 
        MessageBox.Show("The text could not be located.");
    } 
}

Using a Range Object

Using a Range object enables you to search for text without displaying anything in the user interface. The Find object returns True if text is found that matches the search criteria, and False if it does not. It also redefines the Range object to match the search criteria if the text is found.

To find text using a Range object

1. Define a Range object that consists of the second paragraph in the document.

   The following code example can be used in a document-level customization.

   Dim rng As Word.Range = Me.Paragraphs(2).Range
   

   Word.Range rng = this.Paragraphs[2].Range; 
   

   The following code example can be used in an application-level add-in. This example uses the active document.

   Dim rng As Word.Range = Me.Application.ActiveDocument.Paragraphs(2).Range
   

   Word.Document document = this.Application.ActiveDocument;
   Word.Range rng = document.Paragraphs[2].Range;
   

2. Using the Find property of the Range object, first clear any existing formatting options, and then search for the string find me.

   rng.Find.ClearFormatting()
   
   If rng.Find.Execute(findText) Then
   

   rng.Find.ClearFormatting();
   
   if (rng.Find.Execute(ref findText,
       ref missing, ref missing, ref missing, ref missing, ref missing, ref missing,
       ref missing, ref missing, ref missing, ref missing, ref missing, ref missing, 
       ref missing, ref missing)) 
   { 
   

3. Display the results of the search in a message box, and select the Range to make it visible.

       MessageBox.Show("Text found.")
   Else
       MessageBox.Show("Text not found.")
   End If
   
   rng.Select()
   

       MessageBox.Show("Text found.");
   } 
   else 
   { 
       MessageBox.Show("Text not found.");
   } 
   
   rng.Select(); 
   

   If the search fails, the second paragraph is selected; if it succeeds, the search criteria are displayed.

The following example shows the complete code for a document-level customization. To use this example, run the code from the ThisDocument class in your project.

Private Sub RangeFind()
    Dim findText As String = "find me" 

    Dim rng As Word.Range = Me.Paragraphs(2).Range

    rng.Find.ClearFormatting()

    If rng.Find.Execute(findText) Then
        MessageBox.Show("Text found.")
    Else
        MessageBox.Show("Text not found.")
    End If

    rng.Select()
End Sub

private void RangeFind() 
{ 
    object findText = "find me";

    Word.Range rng = this.Paragraphs[2].Range; 

    rng.Find.ClearFormatting();

    if (rng.Find.Execute(ref findText,
        ref missing, ref missing, ref missing, ref missing, ref missing, ref missing,
        ref missing, ref missing, ref missing, ref missing, ref missing, ref missing, 
        ref missing, ref missing)) 
    { 
        MessageBox.Show("Text found.");
    } 
    else 
    { 
        MessageBox.Show("Text not found.");
    } 

    rng.Select(); 
}

The following example shows the complete code for an application-level add-in. To use this example, run the code from the ThisAddIn class in your project.

Private Sub RangeFind()
    Dim findText As Object = "find me" 

    Dim rng As Word.Range = Me.Application.ActiveDocument.Paragraphs(2).Range

    rng.Find.ClearFormatting()

    If rng.Find.Execute(findText) Then
        MessageBox.Show("Text found.")
    Else
        MessageBox.Show("Text not found.")
    End If

    rng.Select()
End Sub

private void RangeFind()
{
    object findText = "find me";

    Word.Document document = this.Application.ActiveDocument;
    Word.Range rng = document.Paragraphs[2].Range;

    rng.Find.ClearFormatting();

    if (rng.Find.Execute(ref findText,
        ref missing, ref missing, ref missing, ref missing, ref missing, ref missing,
        ref missing, ref missing, ref missing, ref missing, ref missing, ref missing,
        ref missing, ref missing))
    {
        MessageBox.Show("Text found.");
    }
    else
    {
        MessageBox.Show("Text not found.");
    }

    rng.Select();
}

See Also

Tasks

How to: Search for and Replace Text in Documents

How to: Set Search Options in Word

How to: Loop Through Found Items in Documents

How to: Define and Select Ranges in Documents

How to: Restore Selections After Searches

Concepts

The Variable missing and Optional Parameters in Office Solutions