HorizontalDateHeaders.CustomDrawDayHeader Event

Enables day headers to be painted in a custom manner.

Namespace: DevExpress.XtraScheduler.Reporting

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

NuGet Package: DevExpress.Win.SchedulerReporting

Declaration

C#

public event CustomDrawObjectEventHandler CustomDrawDayHeader

VB.NET

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.

The event data class exposes the following methods:

Method	Description
DrawDefault()	Renders the element using the default drawing mechanism.
DrawHtml(HtmlTemplate, DxHtmlPainterContext, Action<DxHtmlPainterArgs>)	Paints the required HTML template inside an element that raised this event. The context parameter allows you to assign an object that transfers mouse events to template elements.
DrawHtml(HtmlTemplate, Action<DxHtmlPainterArgs>)	Paints the required HTML template inside an element that raised this event.
GetDisplayValue(String)
GetValue(String)

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.

XtraSchedulerReport1.cs

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));
        }

XtraSchedulerReport1.vb

Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.Drawing
Imports DevExpress.Utils.Controls
Imports System
Imports System.Drawing
        Private Sub horizontalDateHeaders1_CustomDrawDayHeader(ByVal sender As Object, ByVal e As CustomDrawObjectEventArgs)
            Dim header As DayHeader = CType(e.ObjectInfo, DayHeader)
            Dim schema As SchedulerColorSchema = Me.GetResourceColorSchema(header.Resource)
            header.Appearance.HeaderCaption.BackColor = schema.CellLight
            header.Appearance.HeaderCaption.BackColor2 = schema.Cell
            Dim color As 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
        End Sub
        Private Function TransformColor(ByVal color As Color, ByVal light As Double) As Color
            Return System.Drawing.Color.FromArgb(CInt((color.R * light)), CInt((color.G * light)), CInt((color.B * light)))
        End Function

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