Class FilterRowCheckBoxCellRenderer

Represents the class that provides the support for displaying the check box filter row.

Inheritance
System.Object
GridCellRendererBase
GridVirtualizingCellRendererBase<System.Windows.Forms.TextBox>
FilterRowCellRenderer<System.Windows.Forms.TextBox>
FilterRowTextBoxCellRenderer
FilterRowCheckBoxCellRenderer
Implements
System.IDisposable
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.WinForms.DataGrid.RowFilter
Assembly: Syncfusion.SfDataGrid.WinForms.dll
Syntax
public class FilterRowCheckBoxCellRenderer : FilterRowTextBoxCellRenderer, IGridCellRenderer<TableControl>, IDisposable, IFilterRowRenderer

Constructors

FilterRowCheckBoxCellRenderer()

Initializes a new instance of the FilterRowCheckBoxCellRenderer class.

Declaration
public FilterRowCheckBoxCellRenderer()

Methods

GetControlValue()

Gets the control value for the filter row cell renderer.

Declaration
public override object GetControlValue()
Returns
Type Description
System.Object

Returns the value of the cell.
Overrides
Syncfusion.WinForms.DataGrid.RowFilter.FilterRowCellRenderer<System.Windows.Forms.TextBox>.GetControlValue()

OnKeyDown(DataColumnBase, RowColumnIndex, KeyEventArgs)

Overridden to handle the key down event.

Declaration
protected override void OnKeyDown(DataColumnBase dataColumn, RowColumnIndex rowColumnIndex, KeyEventArgs e)
Parameters
Type Name Description
DataColumnBase dataColumn

The DataColumnBase of the cell.
RowColumnIndex rowColumnIndex

The row and column index of the cell.
System.Windows.Forms.KeyEventArgs e

The System.Windows.Forms.KeyEventArgs that contains the event data.
Overrides

OnMouseHoverLeave(DataColumnBase, RowColumnIndex, MouseEventArgs)

Overridden to update the renderer on mouse leave.

Declaration
protected override void OnMouseHoverLeave(DataColumnBase dataColumn, RowColumnIndex rowColumnIndex, MouseEventArgs e)
Parameters
Type Name Description
DataColumnBase dataColumn

The DataColumnBase of the cell.
RowColumnIndex rowColumnIndex

The RowColumnIndex of the cell.
System.Windows.Forms.MouseEventArgs e

An System.Windows.Forms.MouseHoverEventArgs that contains event data.
Overrides
Syncfusion.WinForms.DataGrid.RowFilter.FilterRowCellRenderer<System.Windows.Forms.TextBox>.OnMouseHoverLeave(Syncfusion.WinForms.DataGrid.DataColumnBase, Syncfusion.WinForms.GridCommon.ScrollAxis.RowColumnIndex, System.Windows.Forms.MouseEventArgs)

OnMouseMove(DataColumnBase, RowColumnIndex, MouseEventArgs)

Overridden to update the filter options button state on the mouse move.

Declaration
protected override void OnMouseMove(DataColumnBase column, RowColumnIndex rowColumnIndex, MouseEventArgs e)
Parameters
Type Name Description
DataColumnBase column

The DataColumnBase of the mouse hovered cell.
RowColumnIndex rowColumnIndex

The row column index of the cell.
System.Windows.Forms.MouseEventArgs e

An System.Windows.Forms.MouseHoverEventArgs that contains event data.
Overrides
Syncfusion.WinForms.DataGrid.RowFilter.FilterRowCellRenderer<System.Windows.Forms.TextBox>.OnMouseMove(Syncfusion.WinForms.DataGrid.DataColumnBase, Syncfusion.WinForms.GridCommon.ScrollAxis.RowColumnIndex, System.Windows.Forms.MouseEventArgs)

OnMouseUp(DataColumnBase, RowColumnIndex, MouseEventArgs)

Occurs when the mouse up is performed on the check box filter row cell.

Declaration
protected override void OnMouseUp(DataColumnBase dataColumn, RowColumnIndex rowColumnIndex, MouseEventArgs e)
Parameters
Type Name Description
DataColumnBase dataColumn

The DataColumnBase of the cell.
RowColumnIndex rowColumnIndex

The RowColumnIndex of the cell.
System.Windows.Forms.MouseEventArgs e

An System.Windows.Forms.MouseHoverEventArgs that contains event data.
Overrides
Syncfusion.WinForms.DataGrid.RowFilter.FilterRowCellRenderer<System.Windows.Forms.TextBox>.OnMouseUp(Syncfusion.WinForms.DataGrid.DataColumnBase, Syncfusion.WinForms.GridCommon.ScrollAxis.RowColumnIndex, System.Windows.Forms.MouseEventArgs)

OnRender(Graphics, Rectangle, String, CellStyleInfo, DataColumnBase, RowColumnIndex)

Overridden to draw the check box filter row editor.

Declaration
protected override void OnRender(Graphics paint, Rectangle cellRect, string cellValue, CellStyleInfo style, DataColumnBase column, RowColumnIndex rowColumnIndex)
Parameters
Type Name Description
System.Drawing.Graphics paint

The Graphics of the control.
System.Drawing.Rectangle cellRect

The Bounds of the control.
System.String cellValue

The cell value to be displayed.
CellStyleInfo style

The cell style of the filter row.
DataColumnBase column

The DataColumnBase of the corresponding cell.
RowColumnIndex rowColumnIndex

The row column index of the cell.
Overrides
Syncfusion.WinForms.DataGrid.RowFilter.FilterRowCellRenderer<System.Windows.Forms.TextBox>.OnRender(System.Drawing.Graphics, System.Drawing.Rectangle, System.String, Syncfusion.WinForms.DataGrid.Styles.CellStyleInfo, Syncfusion.WinForms.DataGrid.DataColumnBase, Syncfusion.WinForms.GridCommon.ScrollAxis.RowColumnIndex)

OnUnwireEditUIElement(TextBox)

Overridden to unwire the edit element.

Declaration
protected override void OnUnwireEditUIElement(TextBox uiElement)
Parameters
Type Name Description
System.Windows.Forms.TextBox uiElement

The TextBox control.
Overrides
Syncfusion.WinForms.DataGrid.RowFilter.FilterRowCellRenderer<System.Windows.Forms.TextBox>.OnUnwireEditUIElement(System.Windows.Forms.TextBox)

OpenFilterOptionPopup()

Overridden to cancel the filter options popup.

Declaration
public override void OpenFilterOptionPopup()
Overrides
Syncfusion.WinForms.DataGrid.RowFilter.FilterRowCellRenderer<System.Windows.Forms.TextBox>.OpenFilterOptionPopup()

Implements

System.IDisposable