ColumnHeaderCustomDrawEventArgs.Info Property

Gets an object providing information necessary to paint a column header.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public GridColumnInfoArgs Info { get; }

VB.NET

Public ReadOnly Property Info As GridColumnInfoArgs

Property Value

Type	Description
DevExpress.XtraGrid.Drawing.GridColumnInfoArgs	A DevExpress.XtraGrid.Drawing.GridColumnInfoArgs object providing appearance and state information about a column header.

Remarks

The returned object’s InnerElements property represents a collection of elements displayed within the painted column header (sort glyph, filter button and column header image). Each element is represented by a DevExpress.Utils.Drawing.DrawElementInfo object which enables you to obtain the element’s bounds. Elements can be recognized by the DevExpress.Utils.Drawing.DrawElementInfo.ElementPainter property type. See the GridCustomDraw demo for examples of using the InnerElements property.

The column header’s current state (normal, pressed or hot-tracked) can be obtained via the State property.

The CustomDrawObjectEventArgs.Painter object’s DrawObject method allows you to perform default element painting. This requires the Info property to be passed as the method’s parameter. You can change properties of the Info object before calling the DrawObject method. In this case, the element will be painted using new settings. Alternatively, you can change the Info object’s properties and leave the CustomDrawEventArgs.Handled property set to false. In this case, the element will also be painted using the new settings after executing the event handler.

Related GitHub Examples

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

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#

winforms-grid-custom-button-in-column-header/CS/WindowsApplication3/ColumnHeaderExtender.cs#L125

args.Cache = e.Cache;
args.Bounds = CalcButtonRect(e.Info, e.Cache.Graphics);
ObjectState state = ObjectState.Normal;

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

e.Info.Caption = string.Empty;
e.Painter.DrawObject(e.Info);
e.Handled = true;

multiple-selection-using-checkbox-in-a-master-detail-grid-e3507/CS/E3507/CheckMarkSelection.cs#L310

e.Info.InnerElements.Clear();
e.Painter.DrawObject(e.Info);
DrawCheckBox(e.Cache.Graphics, e.Bounds, AreAllRowsSelected());

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

e.Info.Caption = string.Empty;
e.Painter.DrawObject(e.Info);

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

    //Draw the column header without the sort glyph
    e.Painter.DrawObject(e.Info);
}

VB.NET

winforms-grid-custom-button-in-column-header/VB/WindowsApplication3/ColumnHeaderExtender.vb#L133

args.Cache = e.Cache
args.Bounds = CalcButtonRect(e.Info, e.Cache.Graphics)
Dim state As ObjectState = ObjectState.Normal

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

e.Info.Caption = String.Empty
e.Painter.DrawObject(e.Info)
e.Handled = True

multiple-selection-using-checkbox-in-a-master-detail-grid-e3507/VB/E3507/CheckMarkSelection.vb#L360

e.Info.InnerElements.Clear()
e.Painter.DrawObject(e.Info)
DrawCheckBox(e.Cache.Graphics, e.Bounds, AreAllRowsSelected())

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

e.Info.Caption = String.Empty
e.Painter.DrawObject(e.Info)

winforms-grid-add-check-box-to-column-header/VB/GridViewColumnHeaderExtender.vb#L226

Private Sub DefaultDrawColumnHeader(ByVal e As ColumnHeaderCustomDrawEventArgs)
    e.Painter.DrawObject(e.Info)
End Sub