WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridExcelFilter

    Show / Hide Table of Contents

    Class GridExcelFilter

    Implements the functionalities of optimized Office2007 filter for GridGroupingControl.

    Inheritance
    System.Object
    GridExcelFilter
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.GridHelperClasses
    Assembly: Syncfusion.GridHelperClasses.Windows.dll
    Syntax
    public class GridExcelFilter

    Constructors

    GridExcelFilter()

    Initializes a new instance of the GridExcelFilter class.

    Declaration
    public GridExcelFilter()

    Properties

    AllowFilterByColor

    Gets or sets a value indicating whether the filter by color option should be enabled.

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

    AllowIndividualColumnWiring

    Gets or sets a value indicating whether the desired filter on specified column should be enabled. If the value is set to True, through which the filter can be set in column using 'this.gridGroupingControl1.TableDescriptor.Columns[ColumnName].Appearance.ColumnHeaderCell.CellType = "GridExcelFilterCell"'

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

    AllowResize

    Gets or sets a value indicating whether the filter dialog can be resized.

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

    AllowSearch

    Gets or sets a value indicating whether search operation in checkedlist box of filter should be performed.

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

    ColumnFilter

    Gets or sets the GridFilterMode option in GridExcelFilter to filter the data using display text or value based formatted text. By default GridExcelFilter will be filtered using DisplayMember.

    Declaration
    public GridExcelFilter.GridFilterMode ColumnFilter { get; set; }
    Property Value
    Type Description
    GridExcelFilter.GridFilterMode

    EnableDateFilter

    Gets or sets a value indicating whether date filter can be shown in filter drop down.

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

    EnableFilteredColumnIcon

    Gets or sets a value indicating whether filter icon in the filtered column should be shown.

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

    EnableNumberFilter

    It allows to set enable the number filter

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

    EnableStackedColumnFilterIcon

    Gets or sets a value indicating whether the filter icon in the filtered Stacked column should be shown.

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

    FilterCollection

    Get and sets the collection of objects for filter.

    Declaration
    public Dictionary<string, List<string>> FilterCollection { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

    Methods

    ApplyXml(XmlReader)

    Loads the GridExcelFilter settings from the XML stream.

    Declaration
    public virtual void ApplyXml(XmlReader xr)
    Parameters
    Type Name Description
    System.Xml.XmlReader xr

    XmlReader for de-serializing the GridExcelFilter settings.

    ClearFilters(GridGroupingControl)

    Clears all the filter choices from the GridGroupingControl.

    Declaration
    public void ClearFilters(GridGroupingControl grid)
    Parameters
    Type Name Description
    GridGroupingControl grid

    The GridGroupingControl that holds the filters.

    GetFilterCollection(GridGroupingControl)

    Gets the filter collection values.

    Declaration
    [Obsolete("This Method is duplicated. You can use FilterCollecion instead")]
    public Dictionary<string, List<string>> GetFilterCollection(GridGroupingControl grid)
    Parameters
    Type Name Description
    GridGroupingControl grid

    The GridGroupingControl that contains the filter collection.

    Returns
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

    OnRecordFiltersItemChanged(ListPropertyChangedEventArgs)

    Raises the RecordFiltersItemChanged event.

    Declaration
    public virtual void OnRecordFiltersItemChanged(ListPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    ListPropertyChangedEventArgs e

    The ListPropertyChangedEventArgs that contains the event data.

    OnRecordFiltersItemChanging(ListPropertyChangedEventArgs)

    Raises the RecordFiltersItemChanged event.

    Declaration
    public virtual void OnRecordFiltersItemChanging(ListPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    ListPropertyChangedEventArgs e

    The ListPropertyChangedEventArgs that contains the event data.

    UnWireGrid(GridGroupingControl)

    Unwires the GridGroupingControl from the optimized office2007 filter.

    Declaration
    public void UnWireGrid(GridGroupingControl groupingGrid)
    Parameters
    Type Name Description
    GridGroupingControl groupingGrid

    The GridGroupingControl that wired with office 2007 filter.

    WireGrid(GridGroupingControl)

    Wires the grouping grid to the optimized office2007 filter.

    Declaration
    public void WireGrid(GridGroupingControl groupingGrid)
    Parameters
    Type Name Description
    GridGroupingControl groupingGrid

    The GridGroupingControl that needs to be enabled with office2007 filter.

    WriteXml(XmlWriter)

    Declaration
    public virtual void WriteXml(XmlWriter xw)
    Parameters
    Type Name Description
    System.Xml.XmlWriter xw

    Events

    RecordFiltersItemChanged

    Occurs after an item filtered.

    Declaration
    public event ListPropertyChangedEventHandler RecordFiltersItemChanged
    Event Type
    Type Description
    ListPropertyChangedEventHandler

    RecordFiltersItemChanging

    Occurs after an item filtered.

    Declaration
    public event ListPropertyChangedEventHandler RecordFiltersItemChanging
    Event Type
    Type Description
    ListPropertyChangedEventHandler
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved