SearchTextBox ClassDW.WPFToolkit Documentation
Adds search and cancel buttons to the EnhancedTextBox to represent a search box shown like in the Windows explorer.
Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.MediaVisual
        System.WindowsUIElement
          System.WindowsFrameworkElement
            System.Windows.ControlsControl
              System.Windows.Controls.PrimitivesTextBoxBase
                System.Windows.ControlsTextBox
                  DW.WPFToolkit.ControlsEnhancedTextBox
                    DW.WPFToolkit.ControlsSearchTextBox

Namespace: DW.WPFToolkit.Controls
Assembly: DW.WPFToolkit (in DW.WPFToolkit.dll) Version: 5.6.0.0
Syntax

C#
public class SearchTextBox : EnhancedTextBox

The SearchTextBox type exposes the following members.

Constructors

  NameDescription
Public methodSearchTextBox
Initializes a new instance of the SearchTextBox class
Top
Fields

  NameDescription
Public fieldStatic memberCancelCommandParameterProperty
Identifies the CancelCommandParameter dependency property.
Public fieldStatic memberCancelCommandProperty
Identifies the CancelCommand dependency property.
Public fieldStatic memberHorizontalSearchButtonAlignmentProperty
Identifies the HorizontalSearchButtonAlignment dependency property.
Public fieldStatic memberIsSearchingProperty
Identifies the IsSearching dependency property.
Public fieldStatic memberSearchButtonMarginProperty
Identifies the SearchButtonMargin dependency property.
Public fieldStatic memberSearchButtonPaddingProperty
Identifies the SearchButtonPadding dependency property.
Public fieldStatic memberSearchButtonPositionProperty
Identifies the SearchButtonPosition dependency property.
Public fieldStatic memberSearchCommandParameterProperty
Identifies the SearchCommandParameter dependency property.
Public fieldStatic memberSearchCommandProperty
Identifies the SearchCommand dependency property.
Public fieldStatic memberShowSearchButtonProperty
Identifies the ShowSearchButton dependency property.
Public fieldStatic memberVerticalSearchButtonAlignmentProperty
Identifies the VerticalSearchButtonAlignment dependency property.
Top
Properties

  NameDescription
Public propertyCancelCommand
Gets or sets the command to be called by the cancel button.
Public propertyCancelCommandParameter
Gets or sets the parameter to be passed when the CancelCommand gets executed.
Public propertyHorizontalSearchButtonAlignment
Gets or sets the horizontal alignment of the search button.
Public propertyIsSearching
Gets or sets a value which indicates if the search or cancel button is visible. If true the cancel button is shown; otherwise the search button.
Public propertySearchButtonMargin
Gets or sets the margin of the search button.
Public propertySearchButtonPadding
Gets or sets the padding of the search button.
Public propertySearchButtonPosition
Gets or sets a value which indicates where the search button has to be placed.
Public propertySearchCommand
Gets or sets the command to be called by the search button.
Public propertySearchCommandParameter
Gets or sets the parameter to be passed when the SearchCommand gets executed.
Public propertyShowSearchButton
Gets or sets a value which indicates if the search button is visible or not. This has effect on the cancel button too.
Public propertyVerticalSearchButtonAlignment
Gets or sets the vertical alignment of the search button.
Top
Examples

XAML
<WPFToolkit:SearchTextBox ShowSearchButton="True"
                          SearchCommand="{Binding SearchCommand}"
                          IsSearching="{Binding IsSearching}"
                          CancelCommand="{Binding CancelSearchCommand}" />
See Also

Reference