DayViewTimeRuler.CustomDrawDayViewTimeRuler Event

Enables the DayViewTimeRuler to be printed 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 CustomDrawDayViewTimeRuler

VB.NET

Public Event CustomDrawDayViewTimeRuler As CustomDrawObjectEventHandler

Event Data

The CustomDrawDayViewTimeRuler 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 CustomDrawDayViewTimeRuler event is raised before a DayViewTimeRuler is printed.

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.

The following code sample draws the name of the current time zone in the TimeRuler.

This code snippet uses the GraphicsCache object accessible via the CustomDrawObjectEventArgs.Cache property to paint a colored rectangle containing text in the DayViewTimeRuler visual element of the Scheduler Report. The painted text is the display name of the current time zone.

XtraSchedulerReport1.cs

using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.Drawing;
using System;
using System.Drawing;

        Font arialFont = new Font("Arial", 20, FontStyle.Bold);

        private void dayViewTimeRuler1_CustomDrawDayViewTimeRuler(object sender, CustomDrawObjectEventArgs e)
        {
            e.Cache.FillRectangle(e.Cache.GetSolidBrush(Color.LightYellow), e.Bounds);
            using (StringFormat sf = new StringFormat())
            {
                sf.Alignment = StringAlignment.Center;
                sf.LineAlignment = StringAlignment.Center;
                e.Cache.DrawVString(TimeZoneInfo.Local.DisplayName, arialFont, Brushes.Gray, e.Bounds, sf, -90);
                e.Handled = true;
            }
        }

XtraSchedulerReport1.vb

Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.Drawing
Imports DevExpress.Utils.Controls
Imports System
Imports System.Drawing

        Private arialFont As New Font("Arial", 20, FontStyle.Bold)

        Private Sub dayViewTimeRuler1_CustomDrawDayViewTimeRuler(ByVal sender As Object, ByVal e As CustomDrawObjectEventArgs)
            e.Cache.FillRectangle(e.Cache.GetSolidBrush(Color.LightYellow), e.Bounds)
            Using sf As New StringFormat()
                sf.Alignment = StringAlignment.Center
                sf.LineAlignment = StringAlignment.Center
                e.Cache.DrawVString(TimeZoneInfo.Local.DisplayName, arialFont, Brushes.Gray, e.Bounds, sf, -90)
                e.Handled = True
            End Using
        End Sub