Class TextSearchOptions

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

Inheritance
System.Object
TextSearchOptions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Fixed.Search
Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public class TextSearchOptions : INotifyPropertyChanged

Constructors

TextSearchOptions()

Initializes a new instance of the TextSearchOptions class.

Declaration
public TextSearchOptions()

TextSearchOptions(Boolean)

Initializes a new instance of the TextSearchOptions class.

Declaration
public TextSearchOptions(bool caseSensitive)
Parameters
System.Boolean caseSensitive

The case sensitive option.

TextSearchOptions(Boolean, Boolean)

Initializes a new instance of the TextSearchOptions class.

Declaration
public TextSearchOptions(bool caseSensitive, bool useRegularExpression)
Parameters
System.Boolean caseSensitive

Specifies whether the search should be case sensitive.
System.Boolean useRegularExpression

Specifies whether to use regular expression pattern matching.

TextSearchOptions(Boolean, Boolean, Boolean)

Initializes a new instance of the TextSearchOptions class.

Declaration
public TextSearchOptions(bool caseSensitive, bool useRegularExpression, bool wholeWordsOnly)
Parameters
System.Boolean caseSensitive

Specifies whether the search should be case sensitive.
System.Boolean useRegularExpression

Specifies whether to use regular expression pattern matching.
System.Boolean wholeWordsOnly

Specifies whether to match whole words only.

Properties

CaseSensitive

Gets or sets whether character casing must match exactly.

Declaration
public bool CaseSensitive { get; set; }
Property Value
System.Boolean

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
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
public bool UseRegularExpression { get; set; }
Property Value
System.Boolean

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

WholeWordsOnly

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

Declaration
public bool WholeWordsOnly { get; set; }
Property Value
System.Boolean

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

Events

PropertyChanged

Occurs when a property value changes.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler