SearchBox Class

Definition

Namespace:

Microsoft.Management.UI.Internal

Assembly:

Microsoft.PowerShell.GraphicalHost.dll

Package:

Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Represents a control that parses search text to return a filter expression.

public ref class SearchBox : System::Windows::Controls::Control, Microsoft::Management::UI::Internal::IFilterExpressionProvider

public class SearchBox : System.Windows.Controls.Control, Microsoft.Management.UI.Internal.IFilterExpressionProvider

type SearchBox = class
    inherit Control
    interface IFilterExpressionProvider

Public Class SearchBox
Inherits Control
Implements IFilterExpressionProvider

Inheritance

Control

SearchBox

Implements

IFilterExpressionProvider

Constructors

SearchBox()

Initializes a new instance of the SearchBox class.

Fields

BackgroundTextProperty	Identifies the BackgroundText dependency property.
ClearTextCommand	Clears the search text.
TextProperty	Identifies the Text dependency property.

Properties

BackgroundText	Gets or sets the background text of the search box.
FilterExpression	Gets the filter expression representing the current search text.
HasFilterExpression	Gets a value indicating whether this provider currently has a non-empty filter expression.
Parser	Gets or sets the parser used to parse the search text.
Text	Gets or sets the text contents of the search box.

Methods

ConvertToFilterExpression(ICollection<SearchTextParseResult>)	Converts the specified collection of searchbox items to a filter expression.
NotifyFilterExpressionChanged()	Notifies any listeners that the filter expression has changed.
OnBackgroundTextChanged(PropertyChangedEventArgs<String>)	Called when BackgroundText property changes.
OnClearTextCanExecute(CanExecuteRoutedEventArgs)	Called to determine if ClearText can execute.
OnClearTextExecuted(ExecutedRoutedEventArgs)	Called when ClearText executes.
OnTextChanged(PropertyChangedEventArgs<String>)	Called when Text property changes.

Events

BackgroundTextChanged	Occurs when BackgroundText property changes.
FilterExpressionChanged	Occurs when the filter expression has changed.
TextChanged	Occurs when Text property changes.