TimeCellsControlBase.CustomDrawTimeCell Event

Enables time cells to be painted in a custom manner.

Namespace: DevExpress.XtraScheduler.Reporting

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

Declaration

C#

public event CustomDrawObjectEventHandler CustomDrawTimeCell

VB.NET

Public Event CustomDrawTimeCell As CustomDrawObjectEventHandler

Event Data

The CustomDrawTimeCell event's data class is CustomDrawObjectEventArgs. 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. Use it for custom painting in Scheduler Reports.
Graphics	Gets an object used for painting.
Handled	Gets or sets whether an event was handled. If it was handled, the default actions are not required.
ObjectInfo	Gets information on the painted element.

The event data class exposes the following methods:

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

Remarks

Use the CustomDrawTimeCell event to paint time cells in a custom manner. The cell’s bounding rectangle is identified by the CustomDrawObjectEventArgs.Bounds parameter.

If you custom paint a cell via this event , set the CustomDrawObjectEventArgs.Handled parameter to true. This will indicate that the default painting is not required.

Call the CustomDrawObjectEventArgs.DrawDefault method to perform the default drawing procedure when necessary.

Use the CustomDrawObjectEventArgs.ObjectInfo parameter to get information on the cell currently being painted. You should cast the object to an appropriate type - the TimeCell or the ExtendedCell (for DayViewTimeCells.ExtraCells).

Note

Use the CustomDrawObjectEventArgs.Cache property to paint shapes, write a text and insert images. Do not use the CustomDrawObjectEventArgs.Graphics object in Scheduler Reports.

The following example demonstrates the use of a CustomDrawTimeCell event to add shading to the background of DayViewTimeCells.ExtraCells.

C#

using DevExpress.XtraScheduler.Reporting;
using DevExpress.XtraScheduler.Drawing;
// ...
private void dayViewTimeCells1_CustomDrawTimeCell(object sender, CustomDrawObjectEventArgs e)
{
    TimeCell cell = (TimeCell)e.ObjectInfo;
    if(cell is ExtendedCell) {
        SchedulerColorSchema schema = GetResourceColorSchema(cell.Resource);
        cell.Appearance.BackColor = Color.White;
        cell.Appearance.BackColor2 = schema.CellLight;
        e.DrawDefault();
    }
    e.Handled = true;
}

VB.NET

Imports DevExpress.XtraScheduler.Reporting
Imports DevExpress.XtraScheduler.Drawing
' ...
Private Sub dayViewTimeCells1_CustomDrawTimeCell(ByVal sender As Object,  _
        ByVal e As CustomDrawObjectEventArgs) Handles dayViewTimeCells1.CustomDrawTimeCell
    Dim cell As TimeCell = CType(e.ObjectInfo, TimeCell)
    If TypeOf cell Is ExtendedCell Then
        Dim schema As SchedulerColorSchema = GetResourceColorSchema(cell.Resource)
        cell.Appearance.BackColor = Color.White
        cell.Appearance.BackColor2 = schema.CellLight
        e.DrawDefault()
    End If
    e.Handled = True
End Sub

This event is analogous to the SchedulerControl.CustomDrawTimeCell event of the Scheduler control.

Related GitHub Examples

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

this.dayViewTimeCells1.CustomDrawAppointment += new CustomDrawObjectEventHandler(this.dayViewTimeCells1_CustomDrawAppointment);
this.dayViewTimeCells1.CustomDrawTimeCell += new CustomDrawObjectEventHandler(this.dayViewTimeCells1_CustomDrawTimeCell);
this.dayViewTimeCells1.CustomDrawAppointmentBackground += new CustomDrawObjectEventHandler(this.dayViewTimeCells1_CustomDrawAppointmentBackground);

VB.NET

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

AddHandler dayViewTimeCells1.CustomDrawAppointment, AddressOf dayViewTimeCells1_CustomDrawAppointment
AddHandler dayViewTimeCells1.CustomDrawTimeCell, AddressOf dayViewTimeCells1_CustomDrawTimeCell
AddHandler dayViewTimeCells1.CustomDrawAppointmentBackground, AddressOf dayViewTimeCells1_CustomDrawAppointmentBackground