SpreadsheetControl.CustomDrawRowHeader Event

Enables the row header to be painted manually.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v23.2.dll

NuGet Package: DevExpress.Win.Spreadsheet

Declaration

C#

public event CustomDrawRowHeaderEventHandler CustomDrawRowHeader

VB.NET

Public Event CustomDrawRowHeader As CustomDrawRowHeaderEventHandler

Event Data

The CustomDrawRowHeader event's data class is CustomDrawRowHeaderEventArgs. 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 column index of the row header being painted.
Text	Gets the text of the header caption. Inherited from CustomDrawHeaderEventArgsBase.

The event data class exposes the following methods:

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

Remarks

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

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 code snippet below uses the SpreadsheetControl.CustomDrawRowHeader event to display a row number for every fifth row.

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

C#

using System;
using System.Drawing;
using DevExpress.Spreadsheet;
using DevExpress.XtraSpreadsheet;
// ...
private void spreadsheetControl1_CustomDrawRowHeader(object sender, CustomDrawRowHeaderEventArgs e)
{
    // Cancel default painting for the row header.
    e.Handled = true;

    // Display a row number for every fifth row.
    if ((e.RowIndex + 1) % 5 == 0)
    {
        // Specify font style.
        e.Appearance.FontStyleDelta = FontStyle.Bold;

        // Return the row header bounds.
        Rectangle textBounds = e.Bounds;

        // Specify row header text.
        string text = (e.RowIndex + 1).ToString();

        // Specify text alignment. 
        StringFormat format = new StringFormat {
            LineAlignment = StringAlignment.Center,
            Alignment = StringAlignment.Center
        };

        // Draw row header text.
        e.Graphics.DrawString(text, e.Font, 
            e.Cache.GetSolidBrush(Color.FromArgb(91, 155, 213)), textBounds, format);
    }
}

VB.NET

Imports System
Imports System.Drawing
Imports DevExpress.Spreadsheet
Imports DevExpress.XtraSpreadsheet
' ...
Private Sub spreadsheetControl1_CustomDrawRowHeader(ByVal sender As Object,
    ByVal e As CustomDrawRowHeaderEventArgs)
    ' Cancel default painting for the row header.
    e.Handled = True

    ' Display a row number for every fifth row.
    If (e.RowIndex + 1) Mod 5 = 0 Then
        ' Specify font style.
        e.Appearance.FontStyleDelta = FontStyle.Bold

        ' Return the row header bounds.
        Dim textBounds As Rectangle = e.Bounds

        ' Specify row header text.
        Dim text As String = (e.RowIndex + 1).ToString()

        ' Specify text alignment. 
        Dim format As New StringFormat With {
            .LineAlignment = StringAlignment.Center,
            .Alignment = StringAlignment.Center
        }

        ' Draw row header text.
        e.Graphics.DrawString(text, e.Font,
    e.Cache.GetSolidBrush(Color.FromArgb(91, 155, 213)), textBounds, format)
    End If
End Sub

Related GitHub Examples

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

VB.NET

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

AddHandler spreadsheetControl1.CustomDrawColumnHeaderBackground, AddressOf spreadsheetControl1_CustomDrawColumnHeaderBackground
AddHandler spreadsheetControl1.CustomDrawRowHeader, AddressOf spreadsheetControl1_CustomDrawRowHeader
AddHandler spreadsheetControl1.CustomDrawRowHeaderBackground, AddressOf spreadsheetControl1_CustomDrawRowHeaderBackground