WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridFilterControl - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridFilterControl

    Inheritance
    System.Object
    GridFilterControl
    Implements
    System.IDisposable
    System.ComponentModel.INotifyPropertyChanged
    Namespace: Syncfusion.UI.Xaml.Grid
    Assembly: Syncfusion.SfGrid.WPF.dll
    Syntax
    public class GridFilterControl : ContentControl, IDisposable, INotifyPropertyChanged

    Constructors

    GridFilterControl()

    Declaration
    public GridFilterControl()

    Fields

    AdvancedFilterStyleProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.AdvancedFilterStyle dependency property.

    Declaration
    public static readonly DependencyProperty AdvancedFilterStyleProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridFilterControl.AdvancedFilterStyle dependency property.

    AllowBlankFiltersProperty

    DependencyProperty Registration for AllowBlankFilters

    Declaration
    public static readonly DependencyProperty AllowBlankFiltersProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    AscendingSortStringProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.AscendingSortString dependency property.

    Declaration
    public static readonly DependencyProperty AscendingSortStringProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    CheckboxFilterStyleProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.AdvancedFilterStyle dependency property.

    Declaration
    public static readonly DependencyProperty CheckboxFilterStyleProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridFilterControl.AdvancedFilterStyle dependency property.

    DescendingSortStringProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.DescendingSortString dependency property.

    Declaration
    public static readonly DependencyProperty DescendingSortStringProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    FilterColumnTypeProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.FilterColumnType dependency property.

    Declaration
    public static readonly DependencyProperty FilterColumnTypeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    FilteredFromProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.FilteredFrom dependency property.

    Declaration
    public static readonly DependencyProperty FilteredFromProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    FilterModeProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.FilterMode dependency property.

    Declaration
    public static readonly DependencyProperty FilterModeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridFilterControl.FilterMode dependency property.

    FilterPopUp

    Gets or sets the filter pop up.

    Declaration
    public Popup FilterPopUp
    Field Value
    Type Description
    System.Windows.Controls.Primitives.Popup

    The filter pop up.

    FilterPopupHeightProperty

    DependencyProperty registration for FilterPopupHeight

    Declaration
    public static readonly DependencyProperty FilterPopupHeightProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    FilterPopupWidthProperty

    DependencyProperty registration for FilterPopupWidth

    Declaration
    public static readonly DependencyProperty FilterPopupWidthProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ImmediateUpdateColumnFilterProperty

    DependencyProperty registration for ImmediateUpdateColumnFilter

    Declaration
    public static readonly DependencyProperty ImmediateUpdateColumnFilterProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    IsAdvancedFilterVisibleProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.IsAdvancedFilterVisible dependency property.

    Declaration
    public static readonly DependencyProperty IsAdvancedFilterVisibleProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    IsOpenProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.IsOpen dependency property.

    Declaration
    public static readonly DependencyProperty IsOpenProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ResizingThumbVisibilityProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.ResizingThumbVisibility dependency property.

    Declaration
    public static readonly DependencyProperty ResizingThumbVisibilityProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    SortOptionVisibilityProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridFilterControl.SortOptionVisibility dependency property.

    Declaration
    public static readonly DependencyProperty SortOptionVisibilityProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    Properties

    AdvancedFilterStyle

    Gets or sets the style applied to AdvancedFilterControl.

    Declaration
    public Style AdvancedFilterStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Style

    The style which is applied to AdvancedFilterControl in SfDataGrid. The default value is null.

    Remarks

    To define a System.Windows.Style for a AdvancedFilter, specify a TargetType of AdvancedFilterControl.

    AdvancedFilterType

    Gets or sets AdvancedFilterType for GridFilterControl.

    Declaration
    public AdvancedFilterType AdvancedFilterType { get; set; }
    Property Value
    Type Description
    AdvancedFilterType

    One of the AdvancedFilterType enumeration that specifies which Advanced filter type needs to be loaded. The default value is TextFilter.

    AllowBlankFilters

    Declaration
    public bool AllowBlankFilters { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if ; otherwise, false.

    AscendingSortString

    Gets or sets the AscendingSortString of GridFilterControl.

    Declaration
    public string AscendingSortString { get; set; }
    Property Value
    Type Description
    System.String

    A string that specifies AscendingSortString of GridFilterControl. The default value is string.Empty.

    CheckboxFilterStyle

    Gets or sets the style applied to CheckboxFilterControl.

    Declaration
    public Style CheckboxFilterStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Style

    The style which is applied to CheckboxFilterControl in SfDataGrid. The default value is null.

    Remarks

    To define a System.Windows.Style for a CheckboxFilter, specify a TargetType of CheckboxFilterControl.

    DescendingSortString

    Gets or sets the DescendingSortString of GridFilterControl.

    Declaration
    public string DescendingSortString { get; set; }
    Property Value
    Type Description
    System.String

    A string that specifies DescendingSortString of GridFilterControl. The default value is string.Empty.

    FilterColumnType

    Gets or sets a value indicating FilterColumnType in GridFilterControl.

    Declaration
    public string FilterColumnType { get; set; }
    Property Value
    Type Description
    System.String

    A string that specifies FilterColumnType of GridFilterControl The default value is TextFilters.

    FilteredFrom

    Gets or sets a value indicating whether column is filtered from Checkbox or Advanced filter.

    Declaration
    public FilteredFrom FilteredFrom { get; set; }
    Property Value
    Type Description
    FilteredFrom

    One of the FilteredFrom enumeration that specifies the FilteredFrom The default mode is None.

    FilterMode

    Gets or sets a value to specify the FilterMode in GridFilterControl.

    Declaration
    public FilterMode FilterMode { get; set; }
    Property Value
    Type Description
    FilterMode

    One of the FilterMode enumeration that specifies the FilterMode in SfDataGrid The default mode is Both.

    FilterPopupHeight

    Gets or sets height for Filter popup.

    Declaration
    public double FilterPopupHeight { get; set; }
    Property Value
    Type Description
    System.Double

    FilterPopupWidth

    Gets or sets width for filter popup.

    Declaration
    public double FilterPopupWidth { get; set; }
    Property Value
    Type Description
    System.Double

    ImmediateUpdateColumnFilter

    Gets or sets a value indicating whether ImmediateUpdateColumnFilter.

    Declaration
    public bool ImmediateUpdateColumnFilter { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if ; otherwise, false.

    IsAdvancedFilterVisible

    Gets or sets a value indicating whether AdvancedFilter should be visible or not.

    Declaration
    public bool IsAdvancedFilterVisible { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if AdvancedFilter is visible; otherwise,false. The default value is false.

    IsOpen

    Gets or sets a value that indicates whether the filter popup is opened or not.

    Declaration
    public bool IsOpen { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the filter popup is opened; otherwise, false. The default value is false.

    ResizingThumbVisibility

    Gets or sets a value indicating the ResizingThumb Visibility

    Declaration
    public Visibility ResizingThumbVisibility { get; set; }
    Property Value
    Type Description
    System.Windows.Visibility

    One of the System.Windows.Visibility enumeration that specifies the visibility of ResizingThumb The default mode is System.Windows.Visibility.Visible.

    SortOptionVisibility

    Gets or sets a value indicating the SortOptionVisibility.

    Declaration
    public Visibility SortOptionVisibility { get; set; }
    Property Value
    Type Description
    System.Windows.Visibility

    One of the System.Windows.Visibility enumeration that specifies the visibility of SortOption. The default mode is System.Windows.Visibility.Visible.

    Methods

    Dispose()

    Disposes all the resources used by the GridFilterControl class.

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Disposes all the resources used by the GridFilterControl class.

    Declaration
    protected virtual void Dispose(bool isDisposing)
    Parameters
    Type Name Description
    System.Boolean isDisposing

    Indicates whether the call is from Dispose method or from a finalizer.

    GetFormattedString(Object)

    Gets the formatted text of Actual Value.

    Declaration
    public string GetFormattedString(object item)
    Parameters
    Type Name Description
    System.Object item

    Actual value

    Returns
    Type Description
    System.String

    OnApplyTemplate()

    Builds the visual tree for the GridFilterControl when a new template is applied.

    Declaration
    public override void OnApplyTemplate()

    OnKeyDown(KeyEventArgs)

    Declaration
    protected override void OnKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.KeyEventArgs e

    OnMouseLeftButtonDown(MouseButtonEventArgs)

    Declaration
    protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e

    OnMouseLeftButtonUp(MouseButtonEventArgs)

    Declaration
    protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e

    OnMouseMove(MouseEventArgs)

    Declaration
    protected override void OnMouseMove(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseEventArgs e

    OnMouseWheel(MouseWheelEventArgs)

    Declaration
    protected override void OnMouseWheel(MouseWheelEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseWheelEventArgs e

    OnPropertyChanged(String)

    Declaration
    public void OnPropertyChanged(string propertyName)
    Parameters
    Type Name Description
    System.String propertyName

    SetColumnDataType(Type)

    Set ColumnDataType of AdvancedFilterControl.

    Declaration
    public void SetColumnDataType(Type type)
    Parameters
    Type Name Description
    System.Type type

    specifies the Type

    Events

    OkButtonClick

    Occurs when the OkButton is clicked

    Declaration
    public event EventHandler<OkButtonClikEventArgs> OkButtonClick
    Event Type
    Type Description
    System.EventHandler<OkButtonClikEventArgs>

    OnFilterElementChanged

    Occurs when the FilterElement is changed.

    Declaration
    public event EventHandler<OnFilterElementPropertyChangedEventArgs> OnFilterElementChanged
    Event Type
    Type Description
    System.EventHandler<OnFilterElementPropertyChangedEventArgs>

    PopupOpened

    Occurs when the filter Popup is opened.

    Declaration
    public event EventHandler<PopupOpenedEventArgs> PopupOpened
    Event Type
    Type Description
    System.EventHandler<PopupOpenedEventArgs>

    PropertyChanged

    Declaration
    public event PropertyChangedEventHandler PropertyChanged
    Event Type
    Type Description
    System.ComponentModel.PropertyChangedEventHandler

    Implements

    System.IDisposable
    System.ComponentModel.INotifyPropertyChanged
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved