Back to Devexpress

SpreadsheetControl.CustomDrawColumnHeaderBackground Event

windowsforms-devexpress-dot-xtraspreadsheet-dot-spreadsheetcontrol-3dd7386b.md

latest9.1 KB
Original Source

SpreadsheetControl.CustomDrawColumnHeaderBackground Event

Enables the column header background to be painted manually.

Namespace : DevExpress.XtraSpreadsheet

Assembly : DevExpress.XtraSpreadsheet.v25.2.dll

NuGet Package : DevExpress.Win.Spreadsheet

Declaration

csharp
public event CustomDrawColumnHeaderBackgroundEventHandler CustomDrawColumnHeaderBackground
vb
Public Event CustomDrawColumnHeaderBackground As CustomDrawColumnHeaderBackgroundEventHandler

Event Data

The CustomDrawColumnHeaderBackground event's data class is CustomDrawColumnHeaderBackgroundEventArgs. The following properties provide information specific to this event:

PropertyDescription
AppearanceProvides access to the properties that control the appearance of a worksheet header. Inherited from CustomDrawHeaderEventArgsBase.
BackColorGets the background color of the header. Inherited from CustomDrawHeaderEventArgsBase.
BoundsGets the header’s bound rectangle. Inherited from CustomDrawHeaderEventArgsBase.
CacheGets an object that serves as the storage for pens, fonts and brushes. Inherited from CustomDrawObjectEventsArgs.
ColumnIndexReturns the column index of the column header being painted.
ControlProvides access to the SpreadsheetControl that raised the event. Inherited from CustomDrawHeaderEventArgsBase.
FontGets the font used to paint the header caption. Inherited from CustomDrawHeaderEventArgsBase.
ForeColorGets the color used to paint the header caption text. Inherited from CustomDrawHeaderEventArgsBase.
GraphicsGets an object used for painting. Inherited from CustomDrawObjectEventsArgs.
HandledGets or sets whether an event is handled. If true, the default actions are not required. Inherited from CustomDrawObjectEventsArgs.
IsHoveredGets whether a mouse is currently over the worksheet header. Inherited from CustomDrawHeaderEventArgsBase.
IsSelectedGets whether the current column contains selected cell(s). Inherited from CustomDrawHeaderEventArgsBase.
TextGets the text of the header caption. Inherited from CustomDrawHeaderEventArgsBase.

The event data class exposes the following methods:

MethodDescription
DrawDefault()Renders the element using the default drawing mechanism. Inherited from CustomDrawObjectEventsArgs.

Remarks

The CustomDrawColumnHeaderBackground event is raised before a column header is painted. Event arguments properties provide the objects and information required to paint the column header background.

Set the CustomDrawObjectEventsArgs.Handled property to true to cancel default painting. Use the CustomDrawObjectEventsArgs.DrawDefault method to perform default painting within the event handler.

The following code snippet demonstrates how to change the background color for column headers. This example applies a dark red color to a column header under the mouse pointer or if a header belongs to a column with the active cell:

View Example: Use Custom Draw Events to Customize the Appearance of Spreadsheet Elements

csharp
using System;
using System.Drawing;
using DevExpress.Spreadsheet;
using DevExpress.XtraSpreadsheet;
// ...
private void spreadsheetControl1_CustomDrawColumnHeaderBackground(object sender, 
    CustomDrawColumnHeaderBackgroundEventArgs e)
{
    // Cancel default painting for the column header background.
    e.Handled = true;

    // If the column header is under the mouse pointer or the column contains the active cell,
    // paint the column header background in Color 1.
    // Otherwise, use Color 2.
    if (e.ColumnIndex <= 4) {
        var backColor = e.IsHovered || (e.ColumnIndex == spreadsheetControl1.ActiveCell.ColumnIndex) ?
            //Color 1
            Color.FromArgb(200, 44, 74) :
            //Color 2
            Color.FromArgb(91, 155, 213);
        e.Cache.FillRectangle(e.Cache.GetSolidBrush(backColor), e.Bounds);
    }
}
vb
Imports System
Imports System.Drawing
Imports DevExpress.Spreadsheet
Imports DevExpress.XtraSpreadsheet
' ...
Private Sub spreadsheetControl1_CustomDrawColumnHeaderBackground(ByVal sender As Object,
    ByVal e As CustomDrawColumnHeaderBackgroundEventArgs)
    ' Cancel default painting for the column header background.
    e.Handled = True

    ' If the column header is under the mouse pointer or the column contains the active cell,
    ' paint the column header background in Color 1.
    ' Otherwise, use Color 2.
    If e.ColumnIndex <= 4 Then
        Dim backColor = If(e.IsHovered OrElse (e.ColumnIndex = spreadsheetControl1.ActiveCell.ColumnIndex),
            Color.FromArgb(200, 44, 74), 'Color 1
            Color.FromArgb(91, 155, 213)) ' Color 2
        e.Cache.FillRectangle(e.Cache.GetSolidBrush(backColor), e.Bounds)
    End If
End Sub

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomDrawColumnHeaderBackground event.

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.

winforms-spreadsheet-custom-draw-example/VB/CustomDrawExample/Form1.vb#L20

vb
AddHandler spreadsheetControl1.CustomDrawColumnHeader, AddressOf spreadsheetControl1_CustomDrawColumnHeader
AddHandler spreadsheetControl1.CustomDrawColumnHeaderBackground, AddressOf spreadsheetControl1_CustomDrawColumnHeaderBackground
AddHandler spreadsheetControl1.CustomDrawRowHeader, AddressOf spreadsheetControl1_CustomDrawRowHeader

See Also

SpreadsheetControl Class

SpreadsheetControl Members

DevExpress.XtraSpreadsheet Namespace