TimeCellsControlBase.CustomDrawAppointmentBackground Event

Enables the backgrounds of appointments 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 CustomDrawAppointmentBackground

VB.NET

Public Event CustomDrawAppointmentBackground As CustomDrawObjectEventHandler

Event Data

The CustomDrawAppointmentBackground 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 CustomDrawAppointmentBackground event is raised before the background of an appointment is printed. The event parameter’s CustomDrawObjectEventArgs.ObjectInfo property provides the information on the appointment’s background. The return value of this property should be typecast to the AppointmentViewInfo 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.

This code snippet uses the GraphicsCache object accessible via the CustomDrawObjectEventArgs.Cache property to paint a colored rectangle on the appointment displayed in the DayViewTimeCells visual element of the Scheduler Report.

XtraSchedulerReport1.cs

using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.Drawing;
using System;
using System.Drawing;
        private void dayViewTimeCells1_CustomDrawAppointmentBackground(object sender, CustomDrawObjectEventArgs e)
        {
            e.DrawDefault();
            AppointmentViewInfo vi = (AppointmentViewInfo)e.ObjectInfo;
            Rectangle rect = vi.Bounds;
            rect.Inflate(-vi.LeftBorderBounds.Width, -vi.TopBorderBounds.Height);
            Brush brush = e.Cache.GetGradientBrush(rect, Color.White, vi.Appearance.BackColor,
                System.Drawing.Drawing2D.LinearGradientMode.Vertical);
            e.Cache.FillRectangle(brush, rect);
            e.Handled = true;
        }

XtraSchedulerReport1.vb

Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.Drawing
Imports DevExpress.Utils.Controls
Imports System
Imports System.Drawing
        Private Sub dayViewTimeCells1_CustomDrawAppointmentBackground(ByVal sender As Object, ByVal e As CustomDrawObjectEventArgs)
            e.DrawDefault()
            Dim vi As AppointmentViewInfo = CType(e.ObjectInfo, AppointmentViewInfo)
            Dim rect As Rectangle = vi.Bounds
            rect.Inflate(-vi.LeftBorderBounds.Width, -vi.TopBorderBounds.Height)
            Dim brush As Brush = e.Cache.GetGradientBrush(rect, Color.White, vi.Appearance.BackColor, System.Drawing.Drawing2D.LinearGradientMode.Vertical)
            e.Cache.FillRectangle(brush, rect)
            e.Handled = True
        End Sub

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