Xceed DataGrid for WPF v7.3 Documentation
Xceed.Wpf.DataGrid Assembly / Xceed.Wpf.DataGrid Namespace / FilterCell Class
Members Example


In This Topic
    FilterCell Class
    In This Topic
    Represents a cell contained in a FilterRow in which values can be entered to filter the items displayed in the corresponding column.
    Syntax
    'Declaration
     
    <TemplatePartAttribute(Name="PART_CellContentPresenter", Type=System.Windows.Controls.ContentPresenter)>
    <DefaultPropertyAttribute("Content")>
    <ContentPropertyAttribute("Content")>
    <LocalizabilityAttribute(LocalizationCategory.None, Readability=Readability.Unreadable)>
    <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 FilterCell 
       Inherits Cell
    'Usage
     
    Dim instance As FilterCell
    [TemplatePart(Name="PART_CellContentPresenter", Type=System.Windows.Controls.ContentPresenter)]
    [DefaultProperty("Content")]
    [ContentProperty("Content")]
    [Localizability(LocalizationCategory.None, Readability=Readability.Unreadable)]
    [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 FilterCell : Cell 
    Example
    The following example demonstrates how to add a FilterRow to the fixed headers of a grid's view that will allow the data items in the grid to be filtered according to the user-specified filter criteria.The following example demonstrates how to provide default filter critera that will initially filter the data items in a grid through the FilterRow.
    <Grid xmlns:xcdg="http://schemas.xceed.com/wpf/xaml/datagrid">
      <Grid.Resources>
         <xcdg:DataGridCollectionViewSource x:Key="cvs_products"
                                            Source="{Binding Source={x:Static Application.Current}, Path=Orders}" />
      </Grid.Resources>
      <xcdg:DataGridControl x:Name="OrdersGrid"
                            ItemsSource="{Binding Source={StaticResource cvs_products}}">
         <xcdg:DataGridControl.View>
            <xcdg:TableView>
    
              <xcdg:TableView.FixedHeaders>
                 <DataTemplate>
                    <xcdg:FilterRow Background="Pink" />
                 </DataTemplate>
              </xcdg:TableView.FixedHeaders>
            </xcdg:TableView>
         </xcdg:DataGridControl.View>
      </xcdg:DataGridControl>
    </Grid>
    <Grid xmlns:xcdg="http://schemas.xceed.com/wpf/xaml/datagrid"
         xmlns:s="clr-namespace:System;assembly=mscorlib">
      <Grid.Resources>
         <xcdg:DataGridCollectionViewSource x:Key="cvs_products"
                                            Source="{Binding Source={x:Static Application.Current}, Path=Orders}">
            <xcdg:DataGridCollectionViewSource.ItemProperties>
    
    
             <xcdg:DataGridItemProperty Name="ShipCountry">
                <xcdg:DataGridItemProperty.FilterCriterion>
                   <xcdg:EqualToFilterCriterion Value="Canada" />
                </xcdg:DataGridItemProperty.FilterCriterion>
             </xcdg:DataGridItemProperty>
    
             <xcdg:DataGridItemProperty Name="EmployeeID">
                <xcdg:DataGridItemProperty.FilterCriterion>
                   <xcdg:OrFilterCriterion>
                      <xcdg:OrFilterCriterion.FirstFilterCriterion>
                         <xcdg:EqualToFilterCriterion>
                            <s:Int32>2</s:Int32>
                         </xcdg:EqualToFilterCriterion>
                      </xcdg:OrFilterCriterion.FirstFilterCriterion>
                      <xcdg:OrFilterCriterion.SecondFilterCriterion>
                         <xcdg:EqualToFilterCriterion>
                            <s:Int32>3</s:Int32>
                         </xcdg:EqualToFilterCriterion>
                      </xcdg:OrFilterCriterion.SecondFilterCriterion>
                   </xcdg:OrFilterCriterion>
                </xcdg:DataGridItemProperty.FilterCriterion>
             </xcdg:DataGridItemProperty>
            </xcdg:DataGridCollectionViewSource.ItemProperties>
         </xcdg:DataGridCollectionViewSource>
      </Grid.Resources>
    
    
      <xcdg:DataGridControl x:Name="OrdersGrid"
                            ItemsSource="{Binding Source={StaticResource cvs_products}}">
         <xcdg:DataGridControl.View>
            <xcdg:TableView>
               <xcdg:TableView.FixedHeaders>
                  <DataTemplate>
    
                    <xcdg:FilterRow Background="Pink" />
                  </DataTemplate>
               </xcdg:TableView.FixedHeaders>
            </xcdg:TableView>
         </xcdg:DataGridControl.View>
      </xcdg:DataGridControl>
    </Grid>
    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.ContentControl
                            Xceed.Wpf.DataGrid.Cell
                               Xceed.Wpf.DataGrid.FilterCell

    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