SpreadsheetControl.CustomDrawRowHeaderBackground Event

Enables the row header background to be painted manually.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v20.1.dll

Declaration

public event CustomDrawRowHeaderBackgroundEventHandler CustomDrawRowHeaderBackground
Public Event CustomDrawRowHeaderBackground As CustomDrawRowHeaderBackgroundEventHandler

Event Data

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

Property Description
Appearance Provides access to the properties that control the appearance of a worksheet header. Inherited from CustomDrawHeaderEventArgsBase.
BackColor Gets the background color of the header. Inherited from CustomDrawHeaderEventArgsBase.
Bounds Gets the header's bound rectangle. Inherited from CustomDrawHeaderEventArgsBase.
Cache Gets an object that serves as the storage for pens, fonts and brushes. Inherited from CustomDrawObjectEventsArgs.
Control Provides access to the SpreadsheetControl that raised the event. Inherited from CustomDrawHeaderEventArgsBase.
Font Gets the font used to paint the header caption. Inherited from CustomDrawHeaderEventArgsBase.
ForeColor Gets the color used to paint the header caption text. Inherited from CustomDrawHeaderEventArgsBase.
Graphics Gets an object used for painting. Inherited from CustomDrawObjectEventsArgs.
Handled Gets or sets whether an event is handled. If true, the default actions are not required. Inherited from CustomDrawObjectEventsArgs.
IsHovered Gets whether a mouse is currently over the worksheet header. Inherited from CustomDrawHeaderEventArgsBase.
IsSelected Gets whether the current column contains selected cell(s). Inherited from CustomDrawHeaderEventArgsBase.
RowIndex Returns the row index of the column header being painted.
Text Gets the text of the header caption. Inherited from CustomDrawHeaderEventArgsBase.

Remarks

The CustomDrawRowHeaderBackground event is raised before a row header is painted. Event arguments properties provide the objects and information required to paint the row 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 paints a yellow row header background for rows which contain selected cells or are hovered over with a mouse (the CustomDrawHeaderEventArgsBase.IsHovered property is used to indicate that the header is hovered over).

using System;
using System.Drawing;
using System.Windows.Forms;
using DevExpress.Spreadsheet;
using DevExpress.XtraSpreadsheet;
        void spreadsheetControl1_CustomDrawRowHeaderBackground(object sender, CustomDrawRowHeaderBackgroundEventArgs e)
        {
            e.Handled = true;
            bool is_selected = e.IsHovered || (e.RowIndex == spreadsheetControl1.ActiveCell.RowIndex);
            Color backColor = is_selected ? Color.Yellow : Color.White;
            e.Cache.FillRectangle(e.Cache.GetSolidBrush(backColor), e.Bounds);
        }
See Also