SearchViewBase Class

[TemplatePart(Name = "PART_CloseButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PART_FindAllButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PART_FindNextButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PART_FindWhatTextBox", Type = typeof(TextBox))]
[TemplatePart(Name = "PART_MatchCaseButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PART_MatchWholeWordButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PART_ModeToggleButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PART_ReplaceAllButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PART_ReplaceNextButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PART_ReplaceWithTextBox", Type = typeof(TextBox))]
[TemplatePart(Name = "PART_SearchScopeComboBox", Type = typeof(ComboBox))]
[TemplatePart(Name = "PART_SearchUpButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PART_UseRegularExpressionsButton", Type = typeof(ButtonBase))]
public abstract class SearchViewBase : Control

protected SearchViewBase()

public Duration AnimationDuration { get; set; }

Property Value

Duration:

The Duration of the expander animations. The default value is 100 milliseconds.

public Style ButtonStyle { get; set; }

Property Value

Style:

The Style to apply to buttons.

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.

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 is visible; 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.

public ICommand ReplaceAllCommand { get; }

Property Value

ICommand:

The ICommand that performs a replace all operation.

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 to use when searching within the editor with the search overlay pane.

Remarks

This property defaults to using the static Default property value.

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.

public abstract IEditorView TargetView { get; }

Property Value

IEditorView:

The target IEditorView in which the searching will occur.

public ICommand ToggleOptionsPanelExpandedCommand { get; }

Property Value

ICommand:

The ICommand that performs a replace next operation.

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.

public bool FocusFindWhatTextBox()

Returns

bool:

true if focus was set; otherwise, false.

public override void OnApplyTemplate()

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 OnReplaceWithTextBoxKeyDown(KeyEventArgs e)

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

protected virtual void OnSearchOptionsChanged()

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 RaiseCanExecuteChangedForCommands()

public event EventHandler SearchOptionsChanged

Event Type

EventHandler

public static readonly DependencyProperty AnimationDurationProperty

public static readonly DependencyProperty ButtonStyleProperty

public static readonly DependencyProperty CanToggleReplaceProperty

public static readonly DependencyProperty HasNoSearchResultsProperty

public static readonly DependencyProperty IsFindAllButtonVisibleProperty

public static readonly DependencyProperty IsOptionsPanelExpandedProperty

public static readonly DependencyProperty IsReplaceVisibleProperty

public static readonly DependencyProperty SearchOptionsProperty

public static readonly DependencyProperty SearchPatternProviderFactoryProperty

public static readonly DependencyProperty UseRegularExpressionsProperty