SubDocument.StartSearch(Regex, DocumentRange) Method

Provides a search interface for a search in the specified range using a regular expression pattern.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

IRegexSearchResult StartSearch(
    Regex regex,
    DocumentRange range
)

VB.NET

Function StartSearch(
    regex As Regex,
    range As DocumentRange
) As IRegexSearchResult

Parameters

Name	Type	Description
regex	Regex	A Regex object representing a search pattern.
range	DocumentRange	A DocumentRange object representing a range to search.

Returns

Type	Description
IRegexSearchResult	An IRegexSearchResult interface used to perform a search.

Remarks

The following code snippet illustrates the use of the StartSearch method, to perform searching for the date in US format. Note the use of named captures in the Regular Expression pattern.

The following code illustrates how to find and parse dates in US format using Regular Expression pattern matching:

SearchAndReplace.cs

document.AppendText("12\\14\\2014" + Environment.NewLine);
IRegexSearchResult result;
string pattern = @"(?<mm>\d{2}).(?<dd>\d{2}).(?<yyyy>\d{4})";
System.Text.RegularExpressions.Regex myRegEx = 
    new System.Text.RegularExpressions.Regex(pattern);

result = document.StartSearch(myRegEx);
if (result.FindNext())
{
    string dayFound = result.Match.Groups[2].Value;
    string monthFound = result.Match.Groups[1].Value;
    string yearFound = result.Match.Groups[3].Value;
    document.AppendText(String.Format("Found a date that is the {0} day of the {1} month of the {2} year.",
        dayFound, monthFound, yearFound));
}

SearchAndReplace.vb

document.AppendText("12\14\2014" & Environment.NewLine)
Dim result As IRegexSearchResult
Dim pattern As String = "(?<mm>\d{2}).(?<dd>\d{2}).(?<yyyy>\d{4})"
Dim myRegEx As New System.Text.RegularExpressions.Regex(pattern)

result = document.StartSearch(myRegEx)
If result.FindNext() Then
    Dim dayFound As String = result.Match.Groups(2).Value
    Dim monthFound As String = result.Match.Groups(1).Value
    Dim yearFound As String = result.Match.Groups(3).Value
    document.AppendText(String.Format("Found a date that is the {0} day of the {1} month of the {2} year.", dayFound, monthFound, yearFound))
End If