SpreadsheetControl.CustomDrawCell Event

Provides the capability to perform custom painting of cell content.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v18.1.dll

Declaration

C#

public event CustomDrawCellEventHandler CustomDrawCell

VB.NET

Public Event CustomDrawCell As CustomDrawCellEventHandler

Event Data

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

Property	Description
Bounds	Returns the bounding rectangle of the drawing area.
Cache	Gets an object which specifies the storage for the pens, fonts and brushes. Inherited from CustomDrawObjectEventsArgs.
Cell	Gets the worksheet cell being painted.
FillBounds	Returns the bounding rectangle of the drawing area for painting the cell background.
Font	Gets the font attributes of the painted cell.
ForeColor	Gets or sets the color of the text within the painted cell.
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.
Text	Gets or sets the painted cell’s text.

The event data class exposes the following methods:

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

Remarks

The CustomDrawCell event is raised before a worksheet Cell is painted. Event arguments properties provide the objects and information required to paint the cell.

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 CustomDrawCell event is fired only for existing cells, i.e., the cells that have formatting or content different from the default. Use the Worksheet.GetUsedRange method to obtain a range that comprises existing cells.

Important

Do not change cell values or formatting within this event handler. The events designed to change the appearance or render control elements must not be used to update cell values or to modify the control’s layout. Any operation which causes a layout update may result in incorrect operation or may throw an unhandled exception.

Example

The following code uses the built-in worksheet function RANK.AVG (listed in Statistical Functions document) to calculate the rank of the current cell value in the row. The IWorkbook.Evaluate method of a workbook provides access to worksheet functions, performs the calculation and returns the result. The rank value is transformed into a Roman numeral using the INumberInWordsProvider.ConvertToText method. The Graphics object is used to draw a Roman numeral in the left upper corner of the cell.

Only the top three ranks are displayed. Certain rows are excluded, i.e., custom draw is not performed for cells in those rows..

An area of a sample worksheet that displays cell ranks is shown in the image below.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/xtraspreadsheet-custom-draw-examples-e5044

Form1.cs

using System;
using System.Drawing;
using System.Windows.Forms;
using DevExpress.Spreadsheet;
using DevExpress.XtraSpreadsheet;
        void spreadsheetControl1_CustomDrawCell(object sender, CustomDrawCellEventArgs e)
        {
            if (e.Cell.RowIndex == 0 || e.Cell.RowIndex >= 3) {
                Font headingFont = new Font("Times New Roman", e.Font.Size);
                string cellRef = e.Cell.GetReferenceR1C1(ReferenceElement.RowAbsolute | ReferenceElement.ColumnAbsolute, null);
                string formula = String.Format("=RANK.AVG({0},R{1}C{2}:R{3}C{4})", cellRef, e.Cell.RowIndex + 1, 2, e.Cell.RowIndex + 1, 10);
                int rank = (int)spreadsheetControl1.Document.Evaluate(formula).NumericValue;
                // The DevExpress.Docs.Text.NumberInWords class requires a reference to the DevExpress.Docs assembly. 
                // To redistribute the DevExpress.Docs assembly the DevExpress Universal subscription or the Document Server license is required.
                string rankText = DevExpress.Docs.Text.NumberInWords.Cardinal.ConvertToText(rank, DevExpress.Docs.Text.NumberCulture.Roman);
                if (rank > 0 && rank < 4) e.Graphics.DrawString(rankText, headingFont, e.Cache.GetSolidBrush(Color.Red), e.Bounds.Left, e.Bounds.Top);
            }
        }

Form1.vb

Private Sub spreadsheetControl1_CustomDrawCell(ByVal sender As Object, ByVal e As DevExpress.XtraSpreadsheet.CustomDrawCellEventArgs)
    If e.Cell.RowIndex = 0 OrElse e.Cell.RowIndex >= 3 Then
        Dim headingFont As New Font("Times New Roman", e.Font.Size)
        Dim cellRef As String = e.Cell.GetReferenceR1C1(ReferenceElement.RowAbsolute Or ReferenceElement.ColumnAbsolute, Nothing)
        Dim formula As String = String.Format("=RANK.AVG({0},R{1}C{2}:R{3}C{4})", cellRef, e.Cell.RowIndex + 1, 2, e.Cell.RowIndex + 1, 10)
        Dim rank As Integer = CInt(Fix(spreadsheetControl1.Document.Evaluate(formula).NumericValue))
        Dim rankText As String = DevExpress.Docs.Text.NumberInWords.Cardinal.ConvertToText(rank, DevExpress.Docs.Text.NumberCulture.Roman)
        If rank > 0 AndAlso rank < 4 Then
            e.Graphics.DrawString(rankText, headingFont, e.Cache.GetSolidBrush(Color.Red), e.Bounds.Left, e.Bounds.Top)
        End If
    End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomDrawCell 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.

C#

xtraspreadsheet-custom-draw-examples-e5044/CS/CustomDrawExample/Form1.cs#L26

spreadsheetControl1.CustomDrawRowHeaderBackground += spreadsheetControl1_CustomDrawRowHeaderBackground;
spreadsheetControl1.CustomDrawCell += spreadsheetControl1_CustomDrawCell;
spreadsheetControl1.CustomDrawCellBackground += spreadsheetControl1_CustomDrawCellBackground;

how-to-implement-a-service-to-manage-the-process-of-worksheet-cell-calculation-t270403/CS/CustomCalculationServiceExample/Form1.cs#L27

spreadsheetControl1.AddService(typeof(ICustomCalculationService), calculationService);
spreadsheetControl1.CustomDrawCell += spreadsheetControl1_CustomDrawCell;
spreadsheetControl1.ActiveWorksheet.Cells["A3"].Formula = "A3*B3";

VB.NET

xtraspreadsheet-custom-draw-examples-e5044/VB/CustomDrawExample/Form1.vb#L25

AddHandler spreadsheetControl1.CustomDrawRowHeaderBackground, AddressOf spreadsheetControl1_CustomDrawRowHeaderBackground
AddHandler spreadsheetControl1.CustomDrawCell, AddressOf spreadsheetControl1_CustomDrawCell
AddHandler spreadsheetControl1.CustomDrawCellBackground, AddressOf spreadsheetControl1_CustomDrawCellBackground

how-to-implement-a-service-to-manage-the-process-of-worksheet-cell-calculation-t270403/VB/CustomCalculationServiceExample/Form1.vb#L26

spreadsheetControl1.AddService(GetType(ICustomCalculationService), calculationService)
AddHandler spreadsheetControl1.CustomDrawCell, AddressOf spreadsheetControl1_CustomDrawCell
spreadsheetControl1.ActiveWorksheet.Cells("A3").Formula = "A3*B3"

how-to-use-custom-cell-editors-to-create-a-data-entry-form-t419595/VB/DevAVInvoicing/Form1.vb#L226

' Handle the CustomDrawCell event to mark data entry fields with an asterisk.
Private Sub spreadsheetControl1_CustomDrawCell(ByVal sender As Object, ByVal e As CustomDrawCellEventArgs) Handles spreadsheetControl1.CustomDrawCell
    Dim cellReference As String = e.Cell.GetReferenceA1()