WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridCheckBoxSelectorCellRenderer - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridCheckBoxSelectorCellRenderer

    Represents the class that is used for drawing the check box selector cell.

    Inheritance
    System.Object
    GridCellRendererBase
    GridCheckBoxCellRenderer
    GridCheckBoxSelectorCellRenderer
    Implements
    IGridCellRenderer<TableControl>
    System.IDisposable
    Inherited Members
    GridCheckBoxCellRenderer.OnMouseMove(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCheckBoxCellRenderer.OnMouseHoverLeave(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.SetCurrentCellState(RowColumnIndex, Control, Boolean, Boolean)
    GridCellRendererBase.ResetCurrentCellState()
    GridCellRendererBase.SetFocus(Boolean)
    GridCellRendererBase.UnloadUIElement()
    GridCellRendererBase.Dispose()
    GridCellRendererBase.Render(Graphics, Rectangle, String, CellStyleInfo, DataColumnBase, RowColumnIndex)
    GridCellRendererBase.MouseHover(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.MouseMove(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.MouseHoverLeave(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.MouseUp(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.MouseDown(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.MouseDoubleClick(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.UpdateEditElement(DataColumnBase, Control, Rectangle)
    GridCellRendererBase.DrawErrorIcon(Graphics, Rectangle, Bitmap, RowColumnIndex)
    GridCellRendererBase.KeyDown(DataColumnBase, RowColumnIndex, KeyEventArgs)
    GridCellRendererBase.KeyPress(DataColumnBase, RowColumnIndex, KeyPressEventArgs)
    GridCellRendererBase.KeyUp(DataColumnBase, RowColumnIndex, KeyEventArgs)
    GridCellRendererBase.IGridCellRenderer<TableControl>.OnDrawCurrentCell(Graphics, SfDataGrid, RowColumnIndex)
    GridCellRendererBase.BeginEdit(DataColumnBase, RowColumnIndex)
    GridCellRendererBase.EndEdit(DataColumnBase, RowColumnIndex)
    GridCellRendererBase.CanValidate()
    GridCellRendererBase.SetControlValue(Object)
    GridCellRendererBase.GetControlValue()
    GridCellRendererBase.GetEditorUIElementBounds()
    GridCellRendererBase.GetCellValue()
    GridCellRendererBase.SetFocus(Control, Boolean)
    GridCellRendererBase.OnUpdateEditElement(DataColumnBase, Control, Rectangle)
    GridCellRendererBase.OnDrawCurrentCell(Graphics, SfDataGrid, RowColumnIndex)
    GridCellRendererBase.Dispose(Boolean)
    GridCellRendererBase.OnDrawErrorIcon(Graphics, Rectangle, Bitmap, RowColumnIndex)
    GridCellRendererBase.OnMouseHover(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.OnMouseDoubleClick(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.ShowValidationErrorToolTip(SfToolTip, DataColumnBase, RowColumnIndex, Point)
    GridCellRendererBase.OnKeyPress(DataColumnBase, RowColumnIndex, KeyPressEventArgs)
    GridCellRendererBase.OnKeyUp(DataColumnBase, RowColumnIndex, KeyEventArgs)
    GridCellRendererBase.UpdateCurrentCellState(Control, Boolean)
    GridCellRendererBase.TableControl
    GridCellRendererBase.IsEditable
    GridCellRendererBase.IsFocusable
    GridCellRendererBase.HasCurrentCellState
    GridCellRendererBase.CurrentCellIndex
    GridCellRendererBase.CurrentCellRendererElement
    GridCellRendererBase.IsInEditing
    GridCellRendererBase.IsFocused
    GridCellRendererBase.IsHovered
    GridCellRendererBase.IsPressed
    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.Renderers
    Assembly: Syncfusion.SfDataGrid.WinForms.dll
    Syntax
    public class GridCheckBoxSelectorCellRenderer : GridCheckBoxCellRenderer, IGridCellRenderer<TableControl>, IDisposable
    Examples

    The following example shows how to replace the custom check box selector cell renderer.

    // Remove the existing check box cell renderer and added the custom check box cell renderer.
    sfDataGrid1.CellRenderers.Remove("CheckBoxSelector");
    sfDataGrid1.CellRenderers.Add("CheckBoxSelector", new CustomCheckBoxSelectorRenderer());
    // Implement custom check box renderer.
    public class CustomCheckBoxSelectorRenderer : GridCheckBoxSelectorCellRenderer
    {
        public CustomCheckBoxSelectorRenderer()
        {
        }
    
        protected override void OnRender(Graphics paint, Rectangle cellRect, string cellValue, CellStyleInfo style, DataColumnBase column, RowColumnIndex rowColumnIndex)
        {
            base.OnRender(paint, cellRect, cellValue, style, column, rowColumnIndex);
        }
    
        protected override void OnKeyDown(DataColumnBase dataColumn, RowColumnIndex rowColumnIndex, KeyEventArgs e)
        {
            if (e.KeyCode == Keys.Space)
            {
                // To avoid changing state of the check box on Space key.
                return;
            }
    
            base.OnKeyDown(dataColumn, rowColumnIndex, e);
        }
    }

    Constructors

    GridCheckBoxSelectorCellRenderer()

    Initializes a new instance of the GridCheckBoxSelectorCellRenderer class.

    Declaration
    public GridCheckBoxSelectorCellRenderer()

    Methods

    OnKeyDown(DataColumnBase, RowColumnIndex, KeyEventArgs)

    Occurs when the key is pressed while the cell has focus.

    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
    GridCheckBoxCellRenderer.OnKeyDown(DataColumnBase, RowColumnIndex, KeyEventArgs)

    OnMouseDown(DataColumnBase, RowColumnIndex, MouseEventArgs)

    Occurs when mouse down on the check box cell.

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

    The data column of the check box cell.

    RowColumnIndex rowColumnIndex

    The row and column index of the check box cell.

    System.Windows.Forms.MouseEventArgs e

    The MouseEventArgs that contains the event data.

    Overrides
    GridCellRendererBase.OnMouseDown(DataColumnBase, RowColumnIndex, MouseEventArgs)

    OnMouseUp(DataColumnBase, RowColumnIndex, MouseEventArgs)

    Occurs when mouse up on the check box selector cell.

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

    The data column of the check box selector cell.

    RowColumnIndex rowColumnIndex

    The row and column index of the check box selector cell.

    System.Windows.Forms.MouseEventArgs e

    The MouseEventArgs that contains the event data.

    Overrides
    GridCheckBoxCellRenderer.OnMouseUp(DataColumnBase, RowColumnIndex, MouseEventArgs)

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

    Renders the check box cell for the selector column.

    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 System.Drawing.Graphics that used to draw the check box.

    System.Drawing.Rectangle cellRect

    The cell rectangle.

    System.String cellValue

    The cell value.

    CellStyleInfo style

    The CellStyleInfo of the cell.

    DataColumnBase column

    The DataColumnBase of the cell.

    RowColumnIndex rowColumnIndex

    The row and column index of the cell.

    Overrides
    GridCheckBoxCellRenderer.OnRender(Graphics, Rectangle, String, CellStyleInfo, DataColumnBase, RowColumnIndex)

    Implements

    IGridCellRenderer<T>
    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved