HorizontalDateHeaders.CustomDrawDayHeader Event

Enables day headers to be painted in a custom manner.

Namespace: DevExpress.XtraScheduler.Reporting

Assembly: DevExpress.XtraScheduler.v20.1.Reporting.dll

Declaration

public event CustomDrawObjectEventHandler CustomDrawDayHeader
Public Event CustomDrawDayHeader As CustomDrawObjectEventHandler

Event Data

The CustomDrawDayHeader 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.

Remarks

The CustomDrawDayHeader event is raised before a DayHeader is printed. The event parameter's CustomDrawObjectEventArgs.ObjectInfo property provides the information on an object being painted. The return value of this property should be typecast to the DayHeader type.

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.

Set the CustomDrawObjectEventArgs.Handled property to true to prohibit default appointment painting. Call the CustomDrawObjectEventArgs.DrawDefault method to perform the default drawing procedure if necessary.

The following code sample illustrates the use of the CustomDrawDayHeader event to draw a gradient fill using resource colors, and set the header caption font to bold.

This code snippet illustrates how to change the font and color of the HorizontalDateHeaders visual elements in the Scheduler Report. The XtraSchedulerReport.GetResourceColorSchema method is used to get colors used to paint areas which belong to different resources.

using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.Drawing;
using System;
using System.Drawing;
        private void horizontalDateHeaders1_CustomDrawDayHeader(object sender, CustomDrawObjectEventArgs e)
        {
            DayHeader header = (DayHeader)e.ObjectInfo;
            SchedulerColorSchema schema = this.GetResourceColorSchema(header.Resource);
            header.Appearance.HeaderCaption.BackColor = schema.CellLight;
            header.Appearance.HeaderCaption.BackColor2 = schema.Cell;
            Color color = schema.CellBorderDark;
            header.Appearance.HeaderCaption.ForeColor = TransformColor(color, 0.6);
            header.Appearance.HeaderCaption.Font = e.Cache.GetFont(header.Appearance.HeaderCaption.Font, FontStyle.Bold);
            e.DrawDefault();
            e.Handled = true;
        }
        private Color TransformColor(Color color, double light)
        {
            return Color.FromArgb((int)(color.R * light), (int)(color.G * light), (int)(color.B * light));
        }

The CustomDrawDayHeader event is analogous to the SchedulerControl.CustomDrawDayHeader event of the Scheduler control.

See Also