SubDocument.StartSearch(String, SearchOptions, SearchDirection, DocumentRange) Method

Provides a search interface for a search in the specified range in the specified direction, using the specified options.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

ISearchResult StartSearch(
    string textToFind,
    SearchOptions options,
    SearchDirection direction,
    DocumentRange range
)

VB.NET

Function StartSearch(
    textToFind As String,
    options As SearchOptions,
    direction As SearchDirection,
    range As DocumentRange
) As ISearchResult

Parameters

Name	Type	Description
textToFind	String	A string representing the search text.
options	SearchOptions	A SearchOptions enumeration specifying search options.
direction	SearchDirection	A SearchDirection enumeration specifying the search direction.
range	DocumentRange	A DocumentRange object representing a range to search.

Returns

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the StartSearch(String, SearchOptions, SearchDirection, DocumentRange) 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#

winforms-richedit-search-api/CS/Form1.cs#L29

// Get first search result and start iterating
ISearchResult searchResult = richEditControl1.Document.StartSearch(searchString, SearchOptions.CaseSensitive, SearchDirection.Forward, richEditControl1.Document.Range);

VB.NET

winforms-richedit-search-api/VB/Form1.vb#L31

' Get first search result and start iterating
Dim searchResult As ISearchResult = richEditControl1.Document.StartSearch(searchString, SearchOptions.CaseSensitive, SearchDirection.Forward, richEditControl1.Document.Range)
While searchResult.FindNext()