DayViewTimeRuler.CustomDrawDayViewTimeRuler Event

Enables the DayViewTimeRuler to be printed in a custom manner.

Namespace: DevExpress.XtraScheduler.Reporting

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

Declaration

public event CustomDrawObjectEventHandler CustomDrawDayViewTimeRuler
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.

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.

Report_CustomDrawTimeRuler

using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.Drawing;
using System;
using System.Drawing;
        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,
                    e.Cache.GetFont(new Font(Font.FontFamily, 20, FontStyle.Bold), FontStyle.Bold),
                    e.Cache.GetSolidBrush(Color.Gray), e.Bounds, sf, -90);
                e.Handled = true;
            }
        }
See Also