Class
TextSearchOptions

Encapsulates configuration controlling text search behavior (case sensitivity, regex usage, and whole-word matching).

Definition

Namespace:Telerik.Windows.Documents.Fixed.Search

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

cs-api-definition
public class TextSearchOptions : INotifyPropertyChanged

Inheritance: objectTextSearchOptions

Implements: INotifyPropertyChanged

Constructors

TextSearchOptions()

Initializes a new instance of the TextSearchOptions class.

Declaration

cs-api-definition
public TextSearchOptions()

TextSearchOptions(bool)

Initializes a new instance of the TextSearchOptions class.

Declaration

cs-api-definition
public TextSearchOptions(bool caseSensitive)

Parameters

caseSensitive

bool

The case sensitive option.

TextSearchOptions(bool, bool)

Initializes a new instance of the TextSearchOptions class.

Declaration

cs-api-definition
public TextSearchOptions(bool caseSensitive, bool useRegularExpression)

Parameters

caseSensitive

bool

Specifies whether the search should be case sensitive.

useRegularExpression

bool

Specifies whether to use regular expression pattern matching.

TextSearchOptions(bool, bool, bool)

Initializes a new instance of the TextSearchOptions class.

Declaration

cs-api-definition
public TextSearchOptions(bool caseSensitive, bool useRegularExpression, bool wholeWordsOnly)

Parameters

caseSensitive

bool

Specifies whether the search should be case sensitive.

useRegularExpression

bool

Specifies whether to use regular expression pattern matching.

wholeWordsOnly

bool

Specifies whether to match whole words only.

Properties

CaseSensitive

Gets or sets whether character casing must match exactly.

Declaration

cs-api-definition
public bool CaseSensitive { get; set; }

Property Value

bool

true if the search should be case sensitive; otherwise, false.

Default

Gets a new instance with all options disabled (case-insensitive, literal matching, partial words allowed).

Declaration

cs-api-definition
public static TextSearchOptions Default { get; }

Property Value

TextSearchOptions

The default.

UseRegularExpression

Gets or sets whether the search string is treated as a regular expression pattern.

Declaration

cs-api-definition
public bool UseRegularExpression { get; set; }

Property Value

bool

true if regular expression should be used for searching; otherwise, false.

WholeWordsOnly

Gets or sets whether matches must coincide with whole word boundaries.

Declaration

cs-api-definition
public bool WholeWordsOnly { get; set; }

Property Value

bool

true if only whole words should be matched; otherwise, false.

Events

PropertyChanged

Occurs when a property value changes.

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged