Back to Devexpress

SpreadsheetControl.CustomDrawRowHeaderBackground Event

windowsforms-devexpress-dot-xtraspreadsheet-dot-spreadsheetcontrol-6789b0ab.md

latest8.8 KB
Original Source

SpreadsheetControl.CustomDrawRowHeaderBackground Event

Enables the row header background to be painted manually.

Namespace : DevExpress.XtraSpreadsheet

Assembly : DevExpress.XtraSpreadsheet.v25.2.dll

NuGet Package : DevExpress.Win.Spreadsheet

Declaration

csharp
public event CustomDrawRowHeaderBackgroundEventHandler CustomDrawRowHeaderBackground
vb
Public Event CustomDrawRowHeaderBackground As CustomDrawRowHeaderBackgroundEventHandler

Event Data

The CustomDrawRowHeaderBackground event's data class is CustomDrawRowHeaderBackgroundEventArgs. 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.
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.
RowIndexReturns the row index of the column header being painted.
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 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 snippet demonstrates how to change the background color for row headers. This example applies a dark red color to a row header under the mouse pointer or if a header belongs to a row 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_CustomDrawRowHeaderBackground(object sender, 
    CustomDrawRowHeaderBackgroundEventArgs e)
{
    // Cancel default painting for the row header background.
    e.Handled = true;

    // If the row header is under the mouse pointer or the row contains the active cell,
    // paint the row header background in Color 1.
    // Otherwise, paint the row header in white.
    Color backColor = e.IsHovered || (e.RowIndex == spreadsheetControl1.ActiveCell.RowIndex) ? 
        Color.FromArgb(200, 44, 74) : // Color 1
        Color.White;
    e.Cache.FillRectangle(e.Cache.GetSolidBrush(backColor), e.Bounds);
}
vb
Imports System
Imports System.Drawing
Imports DevExpress.Spreadsheet
Imports DevExpress.XtraSpreadsheet
' ...
Private Sub spreadsheetControl1_CustomDrawRowHeaderBackground(ByVal sender As Object,
    ByVal e As CustomDrawRowHeaderBackgroundEventArgs)
    ' Cancel default painting for the row header background.
    e.Handled = True

    ' If the row header is under the mouse pointer or the row contains the active cell,
    ' paint the row header background in Color 1.
    ' Otherwise, paint the row header in white.
    Dim backColor As Color = If(e.IsHovered OrElse (e.RowIndex = spreadsheetControl1.ActiveCell.RowIndex),
        Color.FromArgb(200, 44, 74), ' Color 1
        Color.White)
    e.Cache.FillRectangle(e.Cache.GetSolidBrush(backColor), e.Bounds)
End Sub

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomDrawRowHeaderBackground 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#L22

vb
AddHandler spreadsheetControl1.CustomDrawRowHeader, AddressOf spreadsheetControl1_CustomDrawRowHeader
AddHandler spreadsheetControl1.CustomDrawRowHeaderBackground, AddressOf spreadsheetControl1_CustomDrawRowHeaderBackground
AddHandler spreadsheetControl1.CustomDrawCell, AddressOf spreadsheetControl1_CustomDrawCell

See Also

SpreadsheetControl Class

SpreadsheetControl Members

DevExpress.XtraSpreadsheet Namespace