Class GridHeaderCellRenderer

Represents the class that used to draw the header cells of the control.

Inheritance
System.Object
GridCellRendererBase
GridHeaderCellRenderer
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.WinForms.DataGrid.Renderers
Assembly: Syncfusion.SfDataGrid.WinForms.dll
Syntax
public class GridHeaderCellRenderer : GridCellRendererBase, IGridCellRenderer<TableControl>, IDisposable

Constructors

GridHeaderCellRenderer()

Initializes a new instance of the GridHeaderCellRenderer class.

Declaration
public GridHeaderCellRenderer()

Methods

OnMouseDown(DataColumnBase, RowColumnIndex, MouseEventArgs)

Occurs when the mouse button is pressed on the header cell.

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

The DataColumnBase of the cell.
RowColumnIndex rowColumnIndex

RowColumnIndex of the header cell on which the mouse button is pressed.
System.Windows.Forms.MouseEventArgs e

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

OnMouseHover(DataColumnBase, RowColumnIndex, MouseEventArgs)

Occurs when the mouse hovers on the header cell.

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

The DataColumnBase of the cell.
RowColumnIndex rowColumnIndex

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

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

OnMouseHoverLeave(DataColumnBase, RowColumnIndex, MouseEventArgs)

Occurs when the mouse leaves the header cell.

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

The DataColumnBase of the cell.
RowColumnIndex rowColumnIndex

RowColumnIndex of the cell from which the mouse leaves.
System.Windows.Forms.MouseEventArgs e

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

OnMouseMove(DataColumnBase, RowColumnIndex, MouseEventArgs)

Occurs when the mouse pointer is moved over the header cell.

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

The DataColumnBase of the header cell.
RowColumnIndex rowColumnIndex

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

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

OnMouseUp(DataColumnBase, RowColumnIndex, MouseEventArgs)

Occurs when the mouse button releases on the header 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

RowColunIndex of the cell on which the mouse button is released.
System.Windows.Forms.MouseEventArgs e

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

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

Overridden to draw the header cell of the table control.

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 cell.
System.Drawing.Rectangle cellRect

The bounds of the cell.
System.String cellValue

The value of the cell.
CellStyleInfo style

The CellStyleInfo of the cell.
DataColumnBase column

The DataColumnBase of the cell.
RowColumnIndex rowColumnIndex

The RowColumnIndex of the cell.
Overrides

Implements

System.IDisposable