C1.WPF.FlexGrid.C1FlexGridFilter
C1FlexGridFilter Class
Implements an Excel-style filter that can be added to existing C1FlexGrid controls.
Namespace: C1.WPF.FlexGrid
Assembly: C1.WPF.FlexGridFilter.4.6.2.dll
Syntax
public class C1FlexGridFilterRemarks
To enable filtering on a C1FlexGrid control, create an instance of a C1FlexGridFilter and pass the grid as a parameter to the constructor. For example:
// enable filtering on the _flex control
var ff = new C1FlexGridFilter(_flex);Constructors
| Name | Description |
|---|---|
| C1FlexGridFilter() | Initializes a new instance of a C1FlexGridFilter. |
| C1FlexGridFilter(C1FlexGrid) | Initializes a new instance of a C1FlexGridFilter. |
Properties
| Name | Description |
|---|---|
| Editor | Gets the Control used to edit the filter parameters. |
| FilterDefinition | Gets or sets the current filter definition as an XML string. |
| NullValueString | Gets or sets the string that represents null values in the value list. |
| Owner | Gets or sets the C1FlexGrid that owns this filter. |
| UseCollectionView | Gets or sets whether the filter should be applied to the grid's data source. |
Methods
| Name | Description |
|---|---|
| Apply() | Applies the current filters to the rows currently loaded on the grid. |
| Clear() | Clears all column filters in this C1FlexGridFilter. |
| GetColumnFilter(Column) | Gets the filter attached to a given grid column. |
| LoadFilterDefinition(XmlReader) | Loads a filter definition from an XmlReader. |
| OnEditorClosed(EventArgs) | Raises the EditorClosed event. |
| OnEditorOpened(EventArgs) | Raises the EditorOpened event. |
| OnFilterApplied(EventArgs) | Raises the FilterApplied event. |
| OnFilterChanged(EventArgs) | Raises the FilterChanged event. |
| SaveFilterDefinition(XmlWriter) | Save the current filter definition to an XmlWriter. |
| ShowFilterEditor(Column) | Show the filter editor for a given grid column. |
Events
| Name | Description |
|---|---|
| EditorClosed | Occurs when the filter editor is closed. |
| EditorOpened | Occurs when the filter editor is displayed. |
| FilterApplied | Occurs when the filter is applied to the grid. |