Page History

Description

Excerpt
Searches for a specified string and returns a collection of type SearchMatch[].

Signature

	C#
	C#

 public virtual SearchMatch[] Search(System.String toMatch)

Signature

	vb.net
	vb.net

Public Overridable Function Search(ByVal toMatch As String) As SearchMatch()

Parameters

Param

	toMatch
	toMatch

The string to find.

Returns
A collection of SearchMatch objects.

Remarks
The search string can be a literal, a regular expression, or a combination of both. Since the string can contain regular expressions, use a backslash to escape special characters. Special characters are `[^$.\|?*+()`. The collection this method returns implements the .NET IEnumerable interface that can be used to iterate over the search results.

Example

Code Block

	csharp
	csharp
title	C#


          //--- Required for IEnumerator
          using System.Collections;

          WordApplication app = new WordAppliation();
          Document doc = app.Open(@"c:\myDoc.doc");

          //--- Search a document for social security numbers, or any series of
          //--- nine digits, and remove them. The question mark after each dash
          //--- makes the presence of the dash optional.
          IEnumerator searcherator = (doc.Search(@"\d\d\d-?\d\d-?\d\d\d\d")).GetEnumerator();
          while (searcherator.MoveNext())
          {
               SearchMatch match = (SearchMatch)searcherator.Current;
               match.Element.DeleteElement();
          }

Code Block

	vb.net
	vb.net
title	vb.net


          '--- Required for IEnumerator
          Imports System.Collections

          Dim app As New WordAppliation()
          Dim doc As Document = app.Open("c:\myDoc.doc")

          '--- Search a document for social security numbers, or any series of
          '--- nine digits, and remove them. The question mark after each dash
          '--- makes the presence of the dash optional.
          Dim searcherator As IEnumerator = (doc.Search("\d\d\d-?\d\d-?\d\d\d\d")).GetEnumerator()
          While searcherator.MoveNext()
               Dim match As SearchMatch = searcherator.Current
               match.Element.DeleteElement()
          End While

Space Shortcuts

Page tree

Versions Compared

Old Version 10

New Version Current

Key