ColumnHeaderCustomDrawEventArgs Class

Provides data for the GridView.CustomDrawColumnHeader event.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v17.2.dll

Declaration

C#

public class ColumnHeaderCustomDrawEventArgs :
    CustomDrawObjectEventArgs

VB.NET

Public Class ColumnHeaderCustomDrawEventArgs
    Inherits CustomDrawObjectEventArgs

Related API Members

ColumnHeaderCustomDrawEventArgs is the data class for the following events:

• GridView.CustomDrawColumnHeader

Remarks

The GridView.CustomDrawColumnHeader event fires before a column header is painted. It enables you to paint column headers manually or modify their appearance settings before they are painted using the default mechanism. ColumnHeaderCustomDrawEventArgs class properties allow you to identify the column whose header is being painted and provide settings common to all custom painting events. Please refer to the Custom Painting Basics topic for details.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ColumnHeaderCustomDrawEventArgs class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-add-a-custom-button-to-a-column-header-in-a-grid-e2793/CS/WindowsApplication3/ColumnHeaderExtender.cs#L111

void OnCustomDrawColumnHeader(object sender, ColumnHeaderCustomDrawEventArgs e) {
    if(e.Column == null) return;

gridcontrol-how-to-add-a-check-box-to-a-column-header-t325446/CS/GridViewColumnHeaderExtender.cs#L154

void OnCustomDrawColumnHeader(object sender, ColumnHeaderCustomDrawEventArgs e)
{

how-to-provide-inplace-editors-for-columns-headers-e2815/CS/WindowsApplication1/InplaceEditorHelper/DrawEditorHelper.cs#L39

}
public static void DrawColumnInplaceEditor(ColumnHeaderCustomDrawEventArgs e, RepositoryItem item, object value, int rightIndent)
{

grid-how-to-custom-paint-sort-glyphs-in-column-headers-t360328/CS/CustomDrawColumnHeader-SortButton/Form1.cs#L34

private void gridView1_CustomDrawColumnHeader(object sender, DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs e) {
    if (e.Column == null) return;

how-to-draw-a-vertical-caption-in-a-column-header-t142821/CS/MyXtraGrid/Form1.cs#L20

private int verticalColumnHeaderPanel = 85;
private void myGridView1_CustomDrawColumnHeader(object sender, DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs e) {
    if (e.Column != null && !e.Column.Visible) {

VB.NET

how-to-add-a-custom-button-to-a-column-header-in-a-grid-e2793/VB/WindowsApplication3/ColumnHeaderExtender.vb#L117

Private Sub OnCustomDrawColumnHeader(ByVal sender As Object, ByVal e As ColumnHeaderCustomDrawEventArgs)
    If e.Column Is Nothing Then

gridcontrol-how-to-add-a-check-box-to-a-column-header-t325446/VB/GridViewColumnHeaderExtender.vb#L146

Private Sub OnCustomDrawColumnHeader(ByVal sender As Object, ByVal e As ColumnHeaderCustomDrawEventArgs)
    If e.Column Is Nothing Then

how-to-provide-inplace-editors-for-columns-headers-e2815/VB/InplaceEditorHelper/DrawEditorHelper.vb#L38

End Function
Public Shared Sub DrawColumnInplaceEditor(ByVal e As ColumnHeaderCustomDrawEventArgs, ByVal item As RepositoryItem, ByVal value As Object, ByVal rightIndent As Integer)
    Dim targetRect As Rectangle = GetEditorBounds(e.Bounds, rightIndent)

grid-how-to-custom-paint-sort-glyphs-in-column-headers-t360328/VB/CustomDrawColumnHeader-SortButton/Form1.vb#L36

Private Sub gridView1_CustomDrawColumnHeader(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs) Handles gridView1.CustomDrawColumnHeader
    If e.Column Is Nothing Then

how-to-draw-a-vertical-caption-in-a-column-header-t142821/VB/MyXtraGrid/Form1.vb#L22

Private verticalColumnHeaderPanel As Integer = 85
Private Sub myGridView1_CustomDrawColumnHeader(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs)
    If e.Column IsNot Nothing AndAlso Not e.Column.Visible Then

Inheritance

Object

EventArgs

CustomDrawEventArgs

CustomDrawObjectEventArgs

ColumnHeaderCustomDrawEventArgs