EditorSearchOptions Class
Stores find/replace options for searching within a view.
public class EditorSearchOptions : IEditorSearchOptions, ISearchOptions, ICloneable, INotifyPropertyChanged- Inheritance:
- System.Object Object
- Implements:
- IEditorSearchOptions ISearchOptions System.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
- System.String:
The text to find.
MatchCase
Gets or sets whether searches should be case sensitive.
public bool MatchCase { get; set; }Property Value
- System.Boolean:
trueif 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
- System.Boolean:
trueif 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
- System.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
- System.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
- System.Boolean:
trueif 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
- System.Object:
A new object that is a copy of this instance.
Equals(Object)
Determines whether the specified System.Object is equal to the current System.Object.
public override bool Equals(object obj)| Parameter | Type | Description |
|---|---|---|
| obj | System.Object | The System.Object to compare with the current System.Object. |
Returns
- System.Boolean:
true if the specified System.Object is equal to the current System.Object; otherwise, false.
Exceptions
| Type | Condition |
|---|---|
| System.NullReferenceException | The |
GetHashCode()
Serves as a hash function for a particular type.
public override int GetHashCode()Returns
- System.Int32:
A hash code for the current System.Object.
NotifyPropertyChanged(String)
Notifies that a property's value has changed.
protected void NotifyPropertyChanged(string name)| Parameter | Type | Description |
|---|---|---|
| name | System.String | The name of the property. |
Events
PropertyChanged
Occurs when a property value is changed.
public event PropertyChangedEventHandler PropertyChangedEvent Type
- System.ComponentModel.PropertyChangedEventHandler
Inherited Members
- System.Object.ToString()
- System.Object.Equals(System.Object, System.Object)
- System.Object.ReferenceEquals(System.Object, System.Object)
- System.Object.GetType()
- System.Object.MemberwiseClone()