FilterControl Class

Represents the control used to filter (search) the items in the listbox.

Syntax

Visual Basic
C#

'Declaration
 
<TemplateVisualStateAttribute(GroupName="LicensingStates", Name="Licensed")>
<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 FilterControl 
   Inherits System.Windows.Controls.Control

'Usage
 
Dim instance As FilterControl

[TemplateVisualState(GroupName="LicensingStates", Name="Licensed")]
[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 FilterControl : System.Windows.Controls.Control

Remarks

The FilterControl class acts as a delaying-providing intermediary between the the SearchTextBox and the ListBox. As the end-user types in the SearchTextBox, the UIFilterExpression property is updated continuously (being bound to SearchTextBox.FilterExpression through two-way binding in the product's default templates) to contain the filter that should be applied to the data. However, the FilterControl waits for the amount of time represented by ApplyFilterInterval to pass, without any other changes being made in the SearchTextBox, before DataSourceFilterExpression (bound to ListBox.FilterExpression in the product's default templates) is updated using UIFilterExpression. The advantage of this approach is that it avoids the filter being applied to the underlying data after each keystroke. By default, the delay value is a TimeSpan representing 700 milliseconds.

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
                     Xceed.Wpf.Controls.FilterControl

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

Reference

FilterControl Members
Xceed.Wpf.Controls Namespace