SearchViewBase Class

public abstract class SearchViewBase : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable

protected SearchViewBase()

public bool CanToggleReplace { get; set; }

Property Value

bool:

true if replace UI can be toggled visible by the end user; otherwise, false. The default value is true.

protected abstract CommandButton FindAllButton { get; }

Property Value

CommandButton:

The find all button.

public ICommand FindAllCommand { get; }

Property Value

ICommand:

The ICommand that performs a find all operation.

public ICommand FindNextCommand { get; }

Property Value

ICommand:

The ICommand that performs a find next operation.

protected TextBox FindWhatTextBox { get; }

Property Value

TextBox:

The TextBox in the template.

public bool HasNoSearchResults { get; set; }

Property Value

bool:

true if there are no search results for the current find text; otherwise, false. The default value is false.

Remarks

When true, some search UI may show an indicator that there is no search match.

public bool IsFindAllButtonVisible { get; set; }

Property Value

bool:

true if the find all button; otherwise, false. The default value is false.

public bool IsOptionsPanelExpanded { get; set; }

Property Value

bool:

true if the options panel is currently visible; otherwise, false. The default value is false.

public bool IsReplaceVisible { get; set; }

Property Value

bool:

true if replace UI is currently visible; otherwise, false. The default value is false.

protected abstract CommandButton MatchCaseButton { get; }

Property Value

CommandButton:

The match case button.

protected abstract CommandButton MatchWholeWordButton { get; }

Property Value

CommandButton:

The match whole word button.

protected abstract CommandButton ModeToggleButton { get; }

Property Value

CommandButton:

The mode toggle button.

protected abstract CommandButton ReplaceAllButton { get; }

Property Value

CommandButton:

The replace all button.

public ICommand ReplaceAllCommand { get; }

Property Value

ICommand:

The ICommand that performs a replace all operation.

protected abstract CommandButton ReplaceNextButton { get; }

Property Value

CommandButton:

The replace next button.

public ICommand ReplaceNextCommand { get; }

Property Value

ICommand:

The ICommand that performs a replace next operation.

protected TextBox ReplaceWithTextBox { get; }

Property Value

TextBox:

The TextBox in the template.

public IEditorSearchOptions SearchOptions { get; set; }

Property Value

IEditorSearchOptions:

The IEditorSearchOptions that specifies the search options to use.

public ISearchPatternProviderFactory SearchPatternProviderFactory { get; set; }

Property Value

ISearchPatternProviderFactory:

The ISearchPatternProviderFactory that creates the collection of available search pattern providers.

public ReadOnlyCollection<ISearchPatternProvider> SearchPatternProviders { get; }

Property Value

ReadOnlyCollection<ISearchPatternProvider>:

The read-only collection of available ISearchPatternProvider objects.

Remarks

Change the SearchPatternProviderFactory property value to update this collection.

protected abstract ComboBox SearchScopeComboBox { get; }

Property Value

ComboBox:

The search scope combobox.

protected abstract CommandButton SearchUpButton { get; }

Property Value

CommandButton:

The search up button.

public abstract IEditorView TargetView { get; }

Property Value

IEditorView:

The target IEditorView in which the searching will occur.

public ICommand ToggleMatchCaseCommand { get; }

Property Value

ICommand:

The ICommand that toggles the match case setting.

public ICommand ToggleMatchWholeWordCommand { get; }

Property Value

ICommand:

The ICommand that toggles the match whole word setting.

public ICommand ToggleModeCommand { get; }

Property Value

ICommand:

The ICommand that toggles replace mode setting.

public ICommand ToggleOptionsPanelExpandedCommand { get; }

Property Value

ICommand:

The ICommand that performs a replace next operation.

public ICommand ToggleSearchUpCommand { get; }

Property Value

ICommand:

The ICommand that toggles the search up setting.

public ICommand ToggleUseRegularExpressionsCommand { get; }

Property Value

ICommand:

The ICommand that toggles the use regular expressions setting.

public bool UseRegularExpressions { get; set; }

Property Value

bool:

true if regular expressions should be used for searching; otherwise, false. The default value is false.

Remarks

Setting this property will toggle the PatternProvider between RegularExpression and Normal.

protected abstract CommandButton UseRegularExpressionsButton { get; }

Property Value

CommandButton:

The use regular expressions button.

protected abstract void ArrangeChildren()

public bool FocusFindWhatTextBox()

Returns

bool:

true if focus was set; otherwise, false.

protected virtual void InitializeChildren()

protected void NotifyPropertyChanged(string propertyName)

Parameter	Type	Description
propertyName	string	The name of the property that was changed.

protected virtual void OnCanToggleReplacePropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void OnFindSearchOptionsChanged()

protected virtual void OnFindWhatTextBoxKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	A KeyEventArgs that contains the event data.

protected virtual void OnIsFindAllButtonVisiblePropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void OnIsOptionsPanelExpandedPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void OnIsReplaceVisiblePropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected override void OnPaddingChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	The EventArgs that contains data related to the event.

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)

Parameter	Type	Description
e	PropertyChangedEventArgs	The PropertyChangedEventArgs that contains the event data.

protected virtual void OnReplaceWithTextBoxKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	A KeyEventArgs that contains the event data.

protected override void OnResize(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnSearchOptionsChanged()

protected virtual void OnSearchOptionsPropertyChanged(IEditorSearchOptions oldValue, IEditorSearchOptions newValue)

Parameter	Type	Description
oldValue	IEditorSearchOptions	The old value.
newValue	IEditorSearchOptions	The new value.

protected virtual void OnSearchOptionsPropertyChanged(PropertyChangedEventArgs e)

Parameter	Type	Description
e	PropertyChangedEventArgs	The PropertyChangedEventArgs that contains the event data.

protected virtual void OnSearchPatternProviderFactoryPropertyChanged(ISearchPatternProviderFactory oldValue, ISearchPatternProviderFactory newValue)

Parameter	Type	Description
oldValue	ISearchPatternProviderFactory	The old value.
newValue	ISearchPatternProviderFactory	The new value.

protected virtual void OnSearchScopeChanged()

protected virtual void OnSearching(SearchOperationType operationType)

Parameter	Type	Description
operationType	SearchOperationType	A SearchOperationType that indicates the search operation type.

protected virtual void OnUseRegularExpressionsPropertyChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value.
newValue	bool	The new value.

protected virtual void RaiseCanExecuteChangedForCommands()

public event PropertyChangedEventHandler PropertyChanged

Event Type

PropertyChangedEventHandler

public event EventHandler SearchOptionsChanged

Event Type

EventHandler