SubDocument.StartSearch(Regex) Method

Provides a search interface for a search in the document, using a regular expression pattern.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

IRegexSearchResult StartSearch(
    Regex regex
)

VB.NET

Function StartSearch(
    regex As Regex
) As IRegexSearchResult

Parameters

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

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.

View Example

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

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));
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the StartSearch(Regex) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/SearchAndReplaceActions.cs#L45

result = document.StartSearch(myRegEx);
if (result.FindNext())

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/SearchAndReplace.cs#L45

result = document.StartSearch(myRegEx);
if (result.FindNext())

how-to-convert-static-urls-to-hyperlinks-e3448/CS/Form1.cs#L59

IRegexSearchResult result;
result = doc.StartSearch(urlRegex);
while (IsValidUri(result))

VB.NET

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/SearchAndReplaceActions.vb#L36

result = document.StartSearch(myRegEx)
If result.FindNext() Then

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/SearchAndReplace.vb#L39

Dim myRegEx As System.Text.RegularExpressions.Regex = New System.Text.RegularExpressions.Regex(pattern)
result = document.StartSearch(myRegEx)
If result.FindNext() Then

how-to-convert-static-urls-to-hyperlinks-e3448/VB/Form1.vb#L49

Dim result As IRegexSearchResult
result = doc.StartSearch(urlRegex)
Do While IsValidUri(result)