In This Article

EditorSearchOptions Class

Stores find/replace options for searching within a view.

public class EditorSearchOptions : IEditorSearchOptions, ISearchOptions, ICloneable, INotifyPropertyChanged
Inheritance:
Object Object
Implements:
IEditorSearchOptions ISearchOptions ICloneable

Constructors

EditorSearchOptions()

public EditorSearchOptions()

Properties

Default

Gets the default IEditorSearchOptions instance that is generally shared among multiple editors.

public static IEditorSearchOptions Default { get; }

Property Value

IEditorSearchOptions:

The default IEditorSearchOptions instance that is generally shared among multiple editors.

FindText

Gets or sets the text to find.

public string FindText { get; set; }

Property Value

String:

The text to find.

MatchCase

Gets or sets whether searches should be case sensitive.

public bool MatchCase { get; set; }

Property Value

Boolean:

true if searches should be case sensitive; otherwise, false.

MatchWholeWord

Gets or sets whether searches should only match whole words.

public bool MatchWholeWord { get; set; }

Property Value

Boolean:

true if searches should only match whole words; otherwise, false.

MaximumResultCount

Gets or sets the maximum number of results that can be found.

public int MaximumResultCount { get; set; }

Property Value

Int32:

The maximum number of results that can be found.

Remarks

The count must be larger than zero.

PatternProvider

Gets or sets the search pattern provider (normal, regular expression, wildcard, etc.).

public ISearchPatternProvider PatternProvider { get; set; }

Property Value

ISearchPatternProvider:

A ISearchPatternProvider specifying the search pattern provider.

ReplaceText

Gets or sets the text with which to replace.

public string ReplaceText { get; set; }

Property Value

String:

The text with which to replace.

Scope

Gets or sets an EditorSearchScope that indicates the scope in which to search.

public EditorSearchScope Scope { get; set; }

Property Value

EditorSearchScope:

An EditorSearchScope that indicates the scope in which to search.

SearchUp

Gets or sets whether to search backwards.

public bool SearchUp { get; set; }

Property Value

Boolean:

true if searches should be performed backwards; otherwise, false.

Methods

Clone()

Creates a new object that is a copy of the current instance.

public virtual object Clone()

Returns

Object:

A new object that is a copy of this instance.

Equals(Object)

Determines whether the specified Object is equal to the current Object.

public override bool Equals(object obj)
Parameter Type Description
obj Object

The Object to compare with the current Object.

Returns

Boolean:

true if the specified Object is equal to the current Object; otherwise, false.

Exceptions

Type Condition
NullReferenceException

The obj parameter is null.

GetHashCode()

Serves as a hash function for a particular type.

public override int GetHashCode()

Returns

Int32:

A hash code for the current Object.

NotifyPropertyChanged(String)

Notifies that a property's value has changed.

protected void NotifyPropertyChanged(string name)
Parameter Type Description
name String

The name of the property.

Events

PropertyChanged

Occurs when a property value is changed.

public event PropertyChangedEventHandler PropertyChanged

Event Type

PropertyChangedEventHandler

Inherited Members