SearchOptions Enum

Lists options used for searching.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

[ComVisible(true)]
[Flags]
public enum SearchOptions

VB.NET

<ComVisible(True)>
<Flags>
Public Enum SearchOptions

Members

Name	Description
None	Performs a search regardless of the case of the characters. Finds the occurrence of a string in a text. Strings will match even if the case is different (e.g. “mystring” will match “myString”).
CaseSensitive	Performs a case sensitive search. Only exact matches are found (e.g. “myString” matches “myString” but not “mystring”).
WholeWord	Search strings will only match if neither an alphabetical character nor a decimal digit occurs on either side of the string.

Remarks

The SearchOptions are specified for the SubDocument.FindAll and SubDocument.ReplaceAll methods. They are used when obtaining the ISearchResult interface via the SubDocument.StartSearch method.

The SearchOptions is a flags enumeration. Combine enumeration members with the unary OR operator to compose a complex option. For example, to perform a case-sensitive search for a whole word, use the (SearchOptions.CaseSensitive | SearchOptions.WholeWord) expression.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SearchOptions enum.

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#

using-the-search-and-replace-api-functionality-e1677/CS/SearchAndReplaceExample/Form1.cs#L28

SearchDirection direction = SearchDirection.Forward;
SearchOptions options = SearchOptions.WholeWord |
    SearchOptions.CaseSensitive;

VB.NET

using-the-search-and-replace-api-functionality-e1677/VB/SearchAndReplaceExample/Form1.vb#L34

Private direction As SearchDirection = SearchDirection.Forward
Private options As SearchOptions = SearchOptions.WholeWord Or _
  SearchOptions.CaseSensitive