CalendarControlBase.CustomDrawDayNumberCell Event

Occurs when drawing each day cell in the calendar.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DXCategory("CustomDraw")]
public event CustomDrawDayNumberCellEventHandler CustomDrawDayNumberCell

VB.NET

<DXCategory("CustomDraw")>
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

The CustomDrawDayNumberCell event fires when a day cell in the calendar is about to be painted. Handle this event, for instance, if you wish to custom paint particular dates, e.g. by highlighting them.

If you custom paint day cells using the CustomDrawDayNumberCell event, set the CustomDrawDayNumberCellEventArgs.Handled parameter to true to prevent the default painting mechanism from being invoked after your CustomDrawDayNumberCell event handler is completed. Otherwise, your painting will be overridden by the default painting mechanism.

Note

You can use drawing methods provided by the e.Graphics object to paint custom information in your CustomDrawDayNumberCell event handler.

Alternatively, you can use drawing methods provided by the e.Cache or e.Style objects. If using the methods provided by the e.Cache or e.Style objects, ensure that the static DevExpress.Utils.Paint.XPaint.ForceGDIPlusPaint method is called on the application startup. Otherwise, you may observe incorrect painting on some operating systems (e.g. Windows 7).

Related GitHub Examples

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

winforms-dashboard-customize-date-filter/CS/DateFilter_Customization/Form1.cs#L42

{
    dateFilter.CalendarFrom.CustomDrawDayNumberCell += Calendar_CustomDrawDayNumberCell;
    dateFilter.CalendarTo.CustomDrawDayNumberCell += Calendar_CustomDrawDayNumberCell;

how-to-highlight-dates-existing-in-a-data-source-in-the-grids-calendar-filter-drop-down-e2485/CS/MyXtraGrid/MyGridView.cs#L47

item = base.CreateRepositoryItem() as RepositoryItemPopupContainerEdit;
DateCalendar.CustomDrawDayNumberCell += OnCustomDrawDayNumberCell;
return item;

VB.NET

winforms-dashboard-customize-date-filter/VB/DateFilter_Customization/Form1.vb#L37

Private Sub SubscribeDateFilterControlEvents(ByVal dateFilter As DateFilterControl)
    AddHandler dateFilter.CalendarFrom.CustomDrawDayNumberCell, AddressOf Calendar_CustomDrawDayNumberCell
    AddHandler dateFilter.CalendarTo.CustomDrawDayNumberCell, AddressOf Calendar_CustomDrawDayNumberCell

how-to-highlight-dates-existing-in-a-data-source-in-the-grids-calendar-filter-drop-down-e2485/VB/MyXtraGrid/MyGridView.vb#L62

item = TryCast(MyBase.CreateRepositoryItem(), RepositoryItemPopupContainerEdit)
AddHandler DateCalendar.CustomDrawDayNumberCell, AddressOf OnCustomDrawDayNumberCell
Return item