menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridCheckBoxCellRenderer - API Reference

    Show / Hide Table of Contents

    Class GridCheckBoxCellRenderer

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

    Inheritance
    System.Object
    GridCellRendererBase
    GridCheckBoxCellRenderer
    GridCheckBoxSelectorCellRenderer
    Implements
    IGridCellRenderer<TableControl>
    System.IDisposable
    Inherited Members
    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.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.OnMouseDown(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 GridCheckBoxCellRenderer : GridCellRendererBase, IGridCellRenderer<TableControl>, IDisposable
    Examples

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

    // Remove the existing check box cell renderer and added the custom check box cell renderer.
    sfDataGrid1.CellRenderers.Remove("CheckBox");
    sfDataGrid1.CellRenderers.Add("CheckBox", new CustomCheckBoxRenderer());
    
    // Implementation for custom check box renderer.
    public class CustomCheckBoxRenderer : GridCheckBoxCellRenderer
    {
        public CustomCheckBoxRenderer()
        {
        }
    
        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

    GridCheckBoxCellRenderer()

    Initializes a new instance of the GridCheckBoxCellRenderer class.

    Declaration
    public GridCheckBoxCellRenderer()

    Methods

    GetControlValue()

    Overridden to get the control value.

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

    Returns the control value.

    Overrides
    GridCellRendererBase.GetControlValue()

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

    OnMouseHoverLeave(DataColumnBase, RowColumnIndex, MouseEventArgs)

    Occurs when the mouse leaves the check box cell.

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

    The DataColumnBase of the check box cell.

    RowColumnIndex rowColumnIndex

    RowColumnIndex of the check box cell from which the mouse leaves.

    System.Windows.Forms.MouseEventArgs e

    The System.Windows.Forms.MouseEventArgs contains the event data.

    Overrides
    GridCellRendererBase.OnMouseHoverLeave(DataColumnBase, RowColumnIndex, MouseEventArgs)

    OnMouseMove(DataColumnBase, RowColumnIndex, MouseEventArgs)

    Occurs when the mouse pointer rests on the check box cell.

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

    The DataColumnBase of the check box cell.

    RowColumnIndex rowColumnIndex

    The row and column index of the check box cell.

    System.Windows.Forms.MouseEventArgs e

    The System.Windows.Forms.MouseEventArgs contains the event data.

    Overrides
    GridCellRendererBase.OnMouseMove(DataColumnBase, RowColumnIndex, MouseEventArgs)

    OnMouseUp(DataColumnBase, RowColumnIndex, MouseEventArgs)

    Occurs when the mouse pointer is over on the cell and a mouse button is released.

    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

    The System.Windows.Forms.MouseEventArgs contains the event data.

    Overrides
    GridCellRendererBase.OnMouseUp(DataColumnBase, RowColumnIndex, MouseEventArgs)

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

    Overridden to draw the check box of the cell.

    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
    GridCellRendererBase.OnRender(Graphics, Rectangle, String, CellStyleInfo, DataColumnBase, RowColumnIndex)

    Implements

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