DayViewTimeCells.CustomDrawDayViewAllDayArea Event

Enables the all-day area of the DayView report to be painted in a custom manner.

Namespace: DevExpress.XtraScheduler.Reporting

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

NuGet Package: DevExpress.Win.SchedulerReporting

Declaration

C#

public event CustomDrawObjectEventHandler CustomDrawDayViewAllDayArea

VB.NET

Public Event CustomDrawDayViewAllDayArea As CustomDrawObjectEventHandler

Event Data

The CustomDrawDayViewAllDayArea 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 CustomDrawDayViewAllDayArea event is raised before the all-day area is printed. The event parameter’s CustomDrawObjectEventArgs.ObjectInfo property provides the information on the visual element being painted. The return value of this property should be typecast to the DevExpress.XtraScheduler.Drawing.AllDayAreaCell 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 AllDayAreaCell 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 dayViewTimeCells1_CustomDrawDayViewAllDayArea(object sender, CustomDrawObjectEventArgs e)
        {
            AllDayAreaCell cell = (AllDayAreaCell)e.ObjectInfo;
            SchedulerColorSchema schema = this.GetResourceColorSchema(cell.Resource);
            cell.Appearance.BackColor = schema.Cell;
            cell.Appearance.BackColor2 = schema.CellBorder;
        }

XtraSchedulerReport1.vb

Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.Drawing
Imports DevExpress.Utils.Controls
Imports System
Imports System.Drawing
        Private Sub dayViewTimeCells1_CustomDrawDayViewAllDayArea(ByVal sender As Object, ByVal e As CustomDrawObjectEventArgs)
            Dim cell As AllDayAreaCell = CType(e.ObjectInfo, AllDayAreaCell)
            Dim schema As SchedulerColorSchema = Me.GetResourceColorSchema(cell.Resource)
            cell.Appearance.BackColor = schema.Cell
            cell.Appearance.BackColor2 = schema.CellBorder
        End Sub