Class DataGridFilterControl
Represents the control for displaying the filter pop up for UI filtering.
Inherited Members
Namespace: Syncfusion.WinForms.DataGrid.GridFiltering
Assembly: Syncfusion.SfDataGrid.WinForms.dll
Syntax
public class DataGridFilterControl : FilterControlBase, IThemeProvider, IVisualStyle
Constructors
DataGridFilterControl()
Initializes a new instance of the DataGridFilterControl class.
Declaration
public DataGridFilterControl()
Properties
Column
Gets or sets the GridColumn associated with the DataGridFilterControl.
Declaration
public GridColumn Column { get; set; }
Property Value
Type |
---|
GridColumn |
DistinctCollection
Gets the unique items collection generated for the column.
Declaration
public List<FilterElement> DistinctCollection { get; }
Property Value
Type |
---|
System.Collections.Generic.List<FilterElement> |
FilterTypeComboItems
Gets or sets the filter type combo box items source.
Declaration
public object FilterTypeComboItems { get; set; }
Property Value
Type |
---|
System.Object |
Methods
CheckListBox_ListViewItemChecked(Object, ItemCheckedEventArgs)
Occurs while checked list box item is checked.
Declaration
protected override void CheckListBox_ListViewItemChecked(object sender, ItemCheckedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
ItemCheckedEventArgs | e | An ItemCheckedEventArgs that contains event data. |
Overrides
Dispose(Boolean)
Overridden to dispose the events and components of the DataGridFilterControl.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing | true to release both managed and unmanaged resources; false to release only unmanaged resources. |
Overrides
GetFormattedValue(Object)
Gets the formatted text of Actual Value.
Declaration
protected virtual string GetFormattedValue(object item)
Parameters
Type | Name | Description |
---|---|---|
System.Object | item | The actual value of the filter element. |
Returns
Type | Description |
---|---|
System.String | Returns the formatted string for the given item. |
InitializeFilterPopup()
Overridden to initialize the advanced filter control settings.
Declaration
public override void InitializeFilterPopup()
Overrides
OnAdvancedFilterButtonClicked(Object, EventArgs)
Overridden to update the OK button state on clicking the advanced filter button.
Declaration
protected override void OnAdvancedFilterButtonClicked(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The System.EventArgs that contains event data. |
Overrides
OnClearFilterButtonClicked(Object, EventArgs)
Overridden to clear the filter predicates applied for the corresponding column.
Declaration
protected override void OnClearFilterButtonClicked(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | An System.EventArgs that contains event data. |
Overrides
OnFilterPopupClosed(Object, ToolStripDropDownClosedEventArgs)
Overridden To update the
Declaration
protected override void OnFilterPopupClosed(object sender, ToolStripDropDownClosedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.Windows.Forms.ToolStripDropDownClosedEventArgs | e | The System.Windows.Forms.ToolStripDropDownClosedEventArgs that contains event data. |
Overrides
OnFilterPopupOpening(Object, CancelEventArgs)
Overridden to update the filter options.
Declaration
protected override void OnFilterPopupOpening(object sender, CancelEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.ComponentModel.CancelEventArgs | e | the System.ComponentModel.CancelEventArgs that contains event data. |
Overrides
OnFirstConditionComboBoxSelectedValueChanged(Object, EventArgs)
Updates the filter value controls based on the selected value of the first filter condition.
Declaration
protected virtual void OnFirstConditionComboBoxSelectedValueChanged(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The System.EventArgs that contains event data. |
OnFirstValueComboBoxTextChanged(Object, EventArgs)
Updates the advanced filters based on the first filter value combo box.
Declaration
protected virtual void OnFirstValueComboBoxTextChanged(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The System.EventArgs that contains event data. |
OnFirstValueTextBoxTextChanged(Object, EventArgs)
Updates the advanced filters based on the text changed in the first filter value.
Declaration
protected virtual void OnFirstValueTextBoxTextChanged(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The System.EventArgs that contains event data. |
OnOKButtonClicked(Object, EventArgs)
Overridden to apply the filters on the data grid.
Declaration
protected override void OnOKButtonClicked(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | An System.EventArgs that contains event data. |
Overrides
OnSearchTextBoxTextChanged(Object, EventArgs)
Overridden to update the selected items based on the search text.
Declaration
protected override void OnSearchTextBoxTextChanged(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The System.EventArgs that contains event data. |
Overrides
OnSecondConditionComboBoxSelectedValueChanged(Object, EventArgs)
Updates the filter value controls based on the selected value of the first second filter condition..
Declaration
protected virtual void OnSecondConditionComboBoxSelectedValueChanged(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The System.EventArgs that contains event data. |
OnSecondValueComboBoxTextChanged(Object, EventArgs)
Updates the advanced filters based on the second filter value.
Declaration
protected virtual void OnSecondValueComboBoxTextChanged(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The System.EventArgs that contains event data. |
OnSecondValueTextBoxTextChanged(Object, EventArgs)
Updates the advanced filters based on the text changed in the second filter value.
Declaration
protected virtual void OnSecondValueTextBoxTextChanged(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The System.EventArgs that contains event data. |
OnSortAscendingButtonClicked(Object, EventArgs)
Overridden to apply the ascending sorting of the column.
Declaration
protected override void OnSortAscendingButtonClicked(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The Syste.EventArgs that contains event data. |
Overrides
OnSortDescendingButtonClicked(Object, EventArgs)
Overridden to apply the descending sorting of the column.
Declaration
protected override void OnSortDescendingButtonClicked(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The Syste.EventArgs that contains event data. |
Overrides
OrRadioButtonCheckedChanged(Object, EventArgs)
Occurs when the radio button value is changed.
Declaration
protected virtual void OrRadioButtonCheckedChanged(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The object of the sender. |
System.EventArgs | e | The System.EventArgs that contains event data. |
ResetDataSource()
Overridden to update the previous data source of the check box filter.
Declaration
protected override void ResetDataSource()
Overrides
SetDataSource(Object)
Overridden to set the data source for the checked list box control.
Declaration
protected override void SetDataSource(object source)
Parameters
Type | Name | Description |
---|---|---|
System.Object | source | The source that needs to set for the checked list box. |
Overrides
Show(Control, Point)
Overridden to show the filter control with the asynchronous loading.
Declaration
public override void Show(Control control, Point location)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Forms.Control | control | The control in which the pop up needs to be shown. |
System.Drawing.Point | location | The location. |
Overrides
WndProc(ref Message)
Processes Windows messages.
Declaration
protected override void WndProc(ref Message m)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Forms.Message | m | The Windows System.Windows.Forms.Message to process. |