HorizontalResourceHeaders.CustomDrawResourceHeader Event

Enables horizontal resource headers to be painted in a custom manner.

Namespace : DevExpress.XtraScheduler.Reporting

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

NuGet Package : DevExpress.Win.SchedulerReporting

Declaration

C#
VB.NET

csharp

public event CustomDrawObjectEventHandler CustomDrawResourceHeader

Public Event CustomDrawResourceHeader As CustomDrawObjectEventHandler

Event Data

The CustomDrawResourceHeader 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 CustomDrawResourceHeader event is raised before a ResourceHeader is printed. The event parameter’s CustomDrawObjectEventArgs.ObjectInfo property provides information on the object being painted. The return value of this property should be typecast to the ResourceHeader 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 painting. Call the CustomDrawObjectEventArgs.DrawDefault method to perform the default drawing procedure if necessary.

This code snippet illustrates how to change the font and color of the HorizontalResourceHeaders visual elements in the Scheduler Report. The XtraSchedulerReport.GetResourceColorSchema method is used to get colors used to paint areas which belong to different resources. The code for the TransformColor method is shown in the code snippet of the HorizontalDateHeaders.CustomDrawDayHeader topic. It is used to lighten the specified color.

XtraSchedulerReport1.cs
XtraSchedulerReport1.vb

csharp

using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.Drawing;
using System;
using System.Drawing;
        private void horizontalResourceHeaders1_CustomDrawResourceHeader(object sender, CustomDrawObjectEventArgs e)
        {
            ResourceHeader header = (ResourceHeader)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;
        }

Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.Drawing
Imports DevExpress.Utils.Controls
Imports System
Imports System.Drawing
        Private Sub horizontalResourceHeaders1_CustomDrawResourceHeader(ByVal sender As Object, ByVal e As CustomDrawObjectEventArgs)
            Dim header As ResourceHeader = CType(e.ObjectInfo, ResourceHeader)
            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