Xceed Logo
Shop
Xceed Toolkit Plus for WPF v5.0 Documentation
Xceed.Wpf.ListBox Assembly / Xceed.Wpf.Controls Namespace / SearchTextBox Class
Members Example


In This Topic
    SearchTextBox Class
    In This Topic
    Represents the text box into which searches (filters) are typed by the end user.
    Syntax
    'Declaration
 
<TemplateVisualStateAttribute(GroupName="FilterStates", Name="NoFilter")>
<LocalizabilityAttribute(LocalizationCategory.Text)>
<ContentPropertyAttribute("Text")>
<TemplatePartAttribute(Name="PART_ContentHost", Type=System.Windows.FrameworkElement)>
<StyleTypedPropertyAttribute(Property="FocusVisualStyle", StyleTargetType=System.Windows.Controls.Control)>
<XmlLangPropertyAttribute("Language")>
<UsableDuringInitializationAttribute(True)>
<RuntimeNamePropertyAttribute("Name")>
<UidPropertyAttribute("Uid")>
<TypeDescriptionProviderAttribute(MS.Internal.ComponentModel.DependencyObjectProvider)>
<NameScopePropertyAttribute("NameScope", System.Windows.NameScope)>
Public Class SearchTextBox 
   Inherits Xceed.Wpf.Toolkit.WatermarkTextBox
   Implements IFilterExpressionProvider 
    'Usage
 
Dim instance As SearchTextBox
    [TemplateVisualState(GroupName="FilterStates", Name="NoFilter")]
[Localizability(LocalizationCategory.Text)]
[ContentProperty("Text")]
[TemplatePart(Name="PART_ContentHost", Type=System.Windows.FrameworkElement)]
[StyleTypedProperty(Property="FocusVisualStyle", StyleTargetType=System.Windows.Controls.Control)]
[XmlLangProperty("Language")]
[UsableDuringInitialization(true)]
[RuntimeNameProperty("Name")]
[UidProperty("Uid")]
[TypeDescriptionProvider(MS.Internal.ComponentModel.DependencyObjectProvider)]
[NameScopeProperty("NameScope", System.Windows.NameScope)]
public class SearchTextBox : Xceed.Wpf.Toolkit.WatermarkTextBox, IFilterExpressionProvider 
    Remarks
    To show the tool pane and therefore the search text box, set ToolPaneVisibility to Visibility.Visible. To activate the search text box, the FilteredFieldNames attached property must be set to a FieldNameList instance representing the fields by which the data can be filtered.
    Example
    <sllb:ListBox x:Name="sllbListBox"
      ItemsSource="{Binding Path=Customers}"
      ItemTemplate="{StaticResource itemTemplate}">
    <sllb:SearchTextBox.FilteredFieldNames>
        <sllb:FieldNameList>
            <s:String>Country</s:String>
        </sllb:FieldNameList>
    </sllb:SearchTextBox.FilteredFieldNames>
</sllb:ListBox>
    Inheritance Hierarchy

    System.Object
       System.Windows.Threading.DispatcherObject
          System.Windows.DependencyObject
             System.Windows.Media.Visual
                System.Windows.UIElement
                   System.Windows.FrameworkElement
                      System.Windows.Controls.Control
                         System.Windows.Controls.Primitives.TextBoxBase
                            System.Windows.Controls.TextBox
                               Xceed.Wpf.Toolkit.AutoSelectTextBox
                                  Xceed.Wpf.Toolkit.WatermarkTextBox
                                     Xceed.Wpf.Controls.SearchTextBox

    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    SearchTextBox Members
    Xceed.Wpf.Controls Namespace

    Send Feedback