How to: Programmatically restore selections after searches

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

If you find and replace text in a document, you might want to restore the user's original selection after the search is completed.

Applies to: The information in this topic applies to document-level projects and VSTO Add-in projects for Word. For more information, see Features available by Office application and project type.

The code in the sample procedure makes use of two Range objects. One stores the current Selection, and one sets the entire document to use as a search range.

  1. Create the Range objects for the document and the current selection.

    Dim start As Word.Range = Application.Selection.Range
Dim searchArea As Word.Range = Application.ActiveDocument.Range

    Word.Range start = Application.Selection.Range; 
Word.Range searchArea = Application.ActiveDocument.Range(ref missing, ref missing);

  2. Perform the search and replace operation.

    searchArea.Find.ClearFormatting()
searchArea.Find.Text = "find me"

searchArea.Find.Replacement.ClearFormatting()
searchArea.Find.Replacement.Text = "Found"

searchArea.Find.Execute(Replace:=Word.WdReplace.wdReplaceAll)

    searchArea.Find.ClearFormatting(); 
searchArea.Find.Text = "find me"; 

searchArea.Find.Replacement.ClearFormatting(); 
searchArea.Find.Replacement.Text = "Found"; 

object replaceAll = Word.WdReplace.wdReplaceAll; 

searchArea.Find.Execute(
    ref missing, ref missing, ref missing, ref missing, ref missing,
    ref missing, ref missing, ref missing, ref missing, ref missing,
    ref replaceAll, ref missing, ref missing, ref missing, ref missing);

  3. Select the start range to restore the user's original selection.

    start.Select()

    start.Select();

    The following example shows the complete method.

Example

Friend Sub ReplaceRestoreSelection()
    Dim start As Word.Range = Application.Selection.Range
    Dim searchArea As Word.Range = Application.ActiveDocument.Range

    searchArea.Find.ClearFormatting()
    searchArea.Find.Text = "find me"

    searchArea.Find.Replacement.ClearFormatting()
    searchArea.Find.Replacement.Text = "Found"

    searchArea.Find.Execute(Replace:=Word.WdReplace.wdReplaceAll)

    start.Select()
End Sub

internal void ReplaceRestoreSelection() 
{ 
    Word.Range start = Application.Selection.Range; 
    Word.Range searchArea = Application.ActiveDocument.Range(ref missing, ref missing); 

    searchArea.Find.ClearFormatting(); 
    searchArea.Find.Text = "find me"; 

    searchArea.Find.Replacement.ClearFormatting(); 
    searchArea.Find.Replacement.Text = "Found"; 

    object replaceAll = Word.WdReplace.wdReplaceAll; 

    searchArea.Find.Execute(
        ref missing, ref missing, ref missing, ref missing, ref missing,
        ref missing, ref missing, ref missing, ref missing, ref missing,
        ref replaceAll, ref missing, ref missing, ref missing, ref missing);

    start.Select(); 
}

See also