Intersoft ClientUI Documentation
UXDataFilter Class
Members  See Also  Send Feedback
Intersoft.Client.UI.Data Namespace : UXDataFilter Class






Provides a user interface for data filtering.

Object Model

UXDataFilter Class

Syntax

Visual Basic (Declaration) 
<TemplatePartAttribute(Name="ScrollViewer", Type=Intersoft.Client.UI.Controls.UXScrollViewer)>
<TemplatePartAttribute(Name="AllCheckBox", Type=Intersoft.Client.UI.Data.UXDataFilterItem)>
<StyleTypedPropertyAttribute(Property="ScrollViewerStyle", StyleTargetType=Intersoft.Client.UI.Controls.UXScrollViewer)>
<StyleTypedPropertyAttribute(Property="GroupBoxStyle", StyleTargetType=Intersoft.Client.UI.Controls.GroupBox)>
<StyleTypedPropertyAttribute(Property="ItemContainerStyle", StyleTargetType=Intersoft.Client.UI.Data.UXDataFilterItem)>
<TemplatePartAttribute(Name="SearchBox", Type=Intersoft.Client.UI.Aqua.UXCollection.UXSearchBox)>
<TemplatePartAttribute(Name="ItemsPresenter", Type=System.Windows.Controls.ItemsPresenter)>
<DescriptionAttribute("Provides a user interface for data filtering.")>
<TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)>
<TemplatePartAttribute(Name="GroupBox", Type=Intersoft.Client.UI.Controls.GroupBox)>
Public Class UXDataFilter 
   Inherits Intersoft.Client.Framework.ISHeaderedItemsControl
   Implements IControl, IFramework, ILicensing, ISelectionItem 
Visual Basic (Usage)Copy Code
Dim instance As UXDataFilter
C# 
[TemplatePartAttribute(Name="ScrollViewer", Type=Intersoft.Client.UI.Controls.UXScrollViewer)]
[TemplatePartAttribute(Name="AllCheckBox", Type=Intersoft.Client.UI.Data.UXDataFilterItem)]
[StyleTypedPropertyAttribute(Property="ScrollViewerStyle", StyleTargetType=Intersoft.Client.UI.Controls.UXScrollViewer)]
[StyleTypedPropertyAttribute(Property="GroupBoxStyle", StyleTargetType=Intersoft.Client.UI.Controls.GroupBox)]
[StyleTypedPropertyAttribute(Property="ItemContainerStyle", StyleTargetType=Intersoft.Client.UI.Data.UXDataFilterItem)]
[TemplatePartAttribute(Name="SearchBox", Type=Intersoft.Client.UI.Aqua.UXCollection.UXSearchBox)]
[TemplatePartAttribute(Name="ItemsPresenter", Type=System.Windows.Controls.ItemsPresenter)]
[DescriptionAttribute("Provides a user interface for data filtering.")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplatePartAttribute(Name="GroupBox", Type=Intersoft.Client.UI.Controls.GroupBox)]
public class UXDataFilter : Intersoft.Client.Framework.ISHeaderedItemsControl, IControl, IFramework, ILicensing, ISelectionItem 
Delphi 
public class UXDataFilter = class(Intersoft.Client.Framework.ISHeaderedItemsControl, IControl, IFramework, ILicensing, ISelectionItem)
JScript 
TemplatePartAttribute(Name="ScrollViewer", Type=Intersoft.Client.UI.Controls.UXScrollViewer)
TemplatePartAttribute(Name="AllCheckBox", Type=Intersoft.Client.UI.Data.UXDataFilterItem)
StyleTypedPropertyAttribute(Property="ScrollViewerStyle", StyleTargetType=Intersoft.Client.UI.Controls.UXScrollViewer)
StyleTypedPropertyAttribute(Property="GroupBoxStyle", StyleTargetType=Intersoft.Client.UI.Controls.GroupBox)
StyleTypedPropertyAttribute(Property="ItemContainerStyle", StyleTargetType=Intersoft.Client.UI.Data.UXDataFilterItem)
TemplatePartAttribute(Name="SearchBox", Type=Intersoft.Client.UI.Aqua.UXCollection.UXSearchBox)
TemplatePartAttribute(Name="ItemsPresenter", Type=System.Windows.Controls.ItemsPresenter)
DescriptionAttribute("Provides a user interface for data filtering.")
TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)
TemplatePartAttribute(Name="GroupBox", Type=Intersoft.Client.UI.Controls.GroupBox)
public class UXDataFilter extends Intersoft.Client.Framework.ISHeaderedItemsControl implements IControl, IFramework, ILicensing, ISelectionItem 
Managed Extensions for C++ 
[TemplatePartAttribute(Name="ScrollViewer", Type=Intersoft.Client.UI.Controls.UXScrollViewer)]
[TemplatePartAttribute(Name="AllCheckBox", Type=Intersoft.Client.UI.Data.UXDataFilterItem)]
[StyleTypedPropertyAttribute(Property="ScrollViewerStyle", StyleTargetType=Intersoft.Client.UI.Controls.UXScrollViewer)]
[StyleTypedPropertyAttribute(Property="GroupBoxStyle", StyleTargetType=Intersoft.Client.UI.Controls.GroupBox)]
[StyleTypedPropertyAttribute(Property="ItemContainerStyle", StyleTargetType=Intersoft.Client.UI.Data.UXDataFilterItem)]
[TemplatePartAttribute(Name="SearchBox", Type=Intersoft.Client.UI.Aqua.UXCollection.UXSearchBox)]
[TemplatePartAttribute(Name="ItemsPresenter", Type=System.Windows.Controls.ItemsPresenter)]
[DescriptionAttribute("Provides a user interface for data filtering.")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplatePartAttribute(Name="GroupBox", Type=Intersoft.Client.UI.Controls.GroupBox)]
public __gc class UXDataFilter : public Intersoft.Client.Framework.ISHeaderedItemsControl, IControl, IFramework, ILicensing, ISelectionItem 
C++/CLI 
[TemplatePartAttribute(Name="ScrollViewer", Type=Intersoft.Client.UI.Controls.UXScrollViewer)]
[TemplatePartAttribute(Name="AllCheckBox", Type=Intersoft.Client.UI.Data.UXDataFilterItem)]
[StyleTypedPropertyAttribute(Property="ScrollViewerStyle", StyleTargetType=Intersoft.Client.UI.Controls.UXScrollViewer)]
[StyleTypedPropertyAttribute(Property="GroupBoxStyle", StyleTargetType=Intersoft.Client.UI.Controls.GroupBox)]
[StyleTypedPropertyAttribute(Property="ItemContainerStyle", StyleTargetType=Intersoft.Client.UI.Data.UXDataFilterItem)]
[TemplatePartAttribute(Name="SearchBox", Type=Intersoft.Client.UI.Aqua.UXCollection.UXSearchBox)]
[TemplatePartAttribute(Name="ItemsPresenter", Type=System.Windows.Controls.ItemsPresenter)]
[DescriptionAttribute("Provides a user interface for data filtering.")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplatePartAttribute(Name="GroupBox", Type=Intersoft.Client.UI.Controls.GroupBox)]
public ref class UXDataFilter : public Intersoft.Client.Framework.ISHeaderedItemsControl, IControl, IFramework, ILicensing, ISelectionItem 

Remarks

The UXDataFilter control provides a configurable user interface for filtering through a data collection. Similar to other ClientUI data controls, UXDataFilter supports both server side and client side operation.

Client Data Operation

Client data operation means that the data operation in this case data filtering is executed in client side against the data source provided to UXDataFilter. To use this mode, you set the QueryOperation property to Client.

You need to wrap your collection in a PagedCollectionView class to provide data filtering functionality to the IEnumerable collection. The PagedCollectionView provides consistent handling for data operation in other data controls as well such as UXGridView and UXDataPager.

To learn how to implement data filter using UXDataFilter, see How-to: Implement Data Filtering using UXDataFilter.

Server Data Operation

Server data operation means that the data operation, in this case data filtering, is processed in the server. This means that UXDataFilter does not handle the filtering operation by its own. Instead, UXDataFilter provides the query information allowing you to process it further.

To use this mode, you set the QueryOperation property to Server. When this mode is selected, UXDataFilter will not attempt to perform the data operation on the given data source. Instead, it will store and distribute the query information to FilterDescriptors property. When the collection of the property change, the QueryChanged event of the associated QueryDescriptor will be raised. This allows you to streamline the query processing in a centralized function, which is one of the strong benefits of QueryDescriptor. For more information about QueryDescriptor, see QueryDescriptor Overview.

To learn how to filter data using FilterDescriptors and UXDataFilter, see How-to: Implement Data Filtering using FilterDescriptors and UXDataFilter.

Inheritance Hierarchy

System.Object
   System.Windows.DependencyObject
      System.Windows.UIElement
         System.Windows.FrameworkElement
            System.Windows.Controls.Control
               System.Windows.Controls.ItemsControl
                  Intersoft.Client.Framework.HeaderedItemsControl
                     Intersoft.Client.Framework.ISHeaderedItemsControl
                        Intersoft.Client.UI.Data.UXDataFilter

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2012 All Rights Reserved.