DayViewTimeRuler.CustomDrawDayViewTimeRuler Event

Enables the DayViewTimeRuler to be printed in a custom manner.

Namespace: DevExpress.XtraScheduler.Reporting

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

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.

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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/scheduler-reporting-custom-painting-using-customdraw-events-e2758

XtraSchedulerReport1.cs

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;
            }
        }

XtraSchedulerReport1.vb

Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.Drawing
Imports DevExpress.Utils.Controls
Imports System
Imports System.Drawing
        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, e.Cache.GetFont(New Font(Font.FontFamily, 20, FontStyle.Bold), FontStyle.Bold), e.Cache.GetSolidBrush(Color.Gray), e.Bounds, sf, -90)
                e.Handled = True
            End Using
        End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomDrawDayViewTimeRuler event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

scheduler-reporting-custom-painting-using-customdraw-events-e2758/CS/SchedulerReportCustomDraw/XtraSchedulerReport1.cs#L33

    this.horizontalResourceHeaders1.CustomDrawResourceHeader += new CustomDrawObjectEventHandler(this.horizontalResourceHeaders1_CustomDrawResourceHeader);
    this.dayViewTimeRuler1.CustomDrawDayViewTimeRuler+=dayViewTimeRuler1_CustomDrawDayViewTimeRuler;
}

VB.NET

scheduler-reporting-custom-painting-using-customdraw-events-e2758/VB/SchedulerReportCustomDraw/XtraSchedulerReport1.vb#L30

    AddHandler horizontalResourceHeaders1.CustomDrawResourceHeader, AddressOf horizontalResourceHeaders1_CustomDrawResourceHeader
    AddHandler Me.dayViewTimeRuler1.CustomDrawDayViewTimeRuler, AddressOf dayViewTimeRuler1_CustomDrawDayViewTimeRuler
End Sub