CalendarControl.CustomDrawDayNumberCell Event

Provides the ability to custom paint dates in the Calendar control.

Namespace: DevExpress.XtraScheduler.Reporting

Assembly: DevExpress.XtraScheduler.v19.2.Reporting.dll

Declaration

C#

public event CustomDrawDayNumberCellEventHandler CustomDrawDayNumberCell

VB.NET

Public Event CustomDrawDayNumberCell As CustomDrawDayNumberCellEventHandler

Event Data

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

Property	Description
BackgroundElementInfo	Gets or sets the skin element that is used to paint the background of the currently processed cell.
Bounds	Gets the painted element’s bounding rectangle.
Cache	Gets an object that specifies the storage for the most used pens, fonts and brushes.
ContentBounds	Gets the bounds of the cell’s content (text).
Date	Gets the painted cell’s value.
Disabled	Gets whether the painted cell is disabled.
Graphics	Gets an object used to paint.
Handled	Gets or sets a value specifying whether default painting is prohibited.
Highlighted	Gets whether the currently processed cell is under the mouse cursor.
Holiday	Gets whether the painted cell corresponds to Saturday or Sunday.
Inactive	Gets whether the painted cell belongs to the previous or next month.
IsPressed	Gets whether the cell is currently pressed.
IsSpecial	Gets whether the cell corresponds to a “special” date.
Selected	Gets a value indicating whether the processed day number cell is selected.
State	Gets the current cell’s state.
Style	Gets the painted date cell’s appearance settings.
Today	Gets whether the painted cell corresponds to Today’s date.
View	Gets or sets the current View of data in the dropdown window.
ViewInfo	Contains information used for painting the current cell.

Remarks

Note

Use the CustomDrawDayNumberCellEventArgs.Cache object for custom painting. Do not use the CustomDrawDayNumberCellEventArgs.Graphics object.

This code snippet illustrates how you can handle the CalendarControl.CustomDrawDayNumberCell event of the CalendarControl to highlight each 12th day of the year, by enclosing it with a hollow violet rectangle.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/scheduler-reporting-custom-painting-using-customdraw-events-e2758

XtraSchedulerReport1.cs

private void calendarControl1_CustomDrawDayNumberCell(object sender, 
    DevExpress.XtraEditors.Calendar.CustomDrawDayNumberCellEventArgs e)
{
    if (e.Date.DayOfYear % 12 == 0)
    {
        Pen p = e.Cache.GetPen(Color.Violet);
        Rectangle r = e.Bounds;
        r.Inflate(-2, 0);
        r.Offset(3, 0);
        e.Cache.DrawRectangle(p, r);
    }
}

XtraSchedulerReport1.vb

Private Sub calendarControl1_CustomDrawDayNumberCell(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Calendar.CustomDrawDayNumberCellEventArgs)
    If e.Date.DayOfYear Mod 12 = 0 Then
        Dim p As Pen = e.Cache.GetPen(Color.Violet)
        Dim r As Rectangle = e.Bounds
        r.Inflate(-2, 0)
        r.Offset(3, 0)
        e.Cache.DrawRectangle(p, r)
    End If
End Sub

Related GitHub Examples

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

scheduler-reporting-custom-painting-using-customdraw-events-e2758/CS/SchedulerReportCustomDraw/XtraSchedulerReport1.cs#L21

SusbcribeToCustomDrawEvents();
calendarControl1.CustomDrawDayNumberCell+=
    new DevExpress.XtraEditors.Calendar.CustomDrawDayNumberCellEventHandler(calendarControl1_CustomDrawDayNumberCell);

VB.NET

scheduler-reporting-custom-painting-using-customdraw-events-e2758/VB/SchedulerReportCustomDraw/XtraSchedulerReport1.vb#L20

    SusbcribeToCustomDrawEvents()
    AddHandler calendarControl1.CustomDrawDayNumberCell, AddressOf calendarControl1_CustomDrawDayNumberCell
End Sub