SchedulerControl.CustomDrawDayOfWeekHeader Event

Enables day of week headers to be painted manually.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v20.2.dll

NuGet Package: DevExpress.Win.Scheduler

Declaration

C#

public event CustomDrawObjectEventHandler CustomDrawDayOfWeekHeader

VB.NET

Public Event CustomDrawDayOfWeekHeader As CustomDrawObjectEventHandler

Event Data

The CustomDrawDayOfWeekHeader 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 CustomDrawDayOfWeekHeader event is raised before the Day of Week header is painted. The event parameter’s CustomDrawObjectEventArgs.ObjectInfo property provides the information which is required to paint a header. The return value of this property should be typecast to the DayOfWeekHeader type.

Set the CustomDrawObjectEventArgs.Handled property to true to prohibit default header painting.

Example

This example paints day headers with green gradient color and draws header captions using white color.

View Example

CustomDraw.cs

public static void scheduler_CustomDrawDayOfWeekHeader(object sender, CustomDrawObjectEventArgs e)
{
    DayOfWeekHeader header = e.ObjectInfo as DayOfWeekHeader;
    // Draw the outer rectangle.
    using(var backBrush = new LinearGradientBrush(e.Bounds,
            Color.LightGreen, Color.Green, LinearGradientMode.Vertical))
        e.Cache.FillRectangle(backBrush, e.Bounds);
    Rectangle innerRect = Rectangle.Inflate(e.Bounds, -2, -2);
    // Draw the inner rectangle.
    using(var backBrush = new LinearGradientBrush(e.Bounds,
            Color.Green, Color.LightGreen, LinearGradientMode.Vertical))
        e.Cache.FillRectangle(backBrush, innerRect);
    // Draw the header caption.
    e.Cache.DrawString(header.Caption, header.Appearance.HeaderCaption.Font,
        Brushes.White, innerRect,
        header.Appearance.HeaderCaption.GetStringFormat());
    e.Handled = true;
}

CustomDraw.vb

Public Shared Sub scheduler_CustomDrawDayOfWeekHeader(ByVal sender As Object, ByVal e As CustomDrawObjectEventArgs)
    Dim header As DayOfWeekHeader = TryCast(e.ObjectInfo, DayOfWeekHeader)
    ' Draw the outer rectangle.
    Using backBrush = New LinearGradientBrush(e.Bounds, Color.LightGreen, Color.Green, LinearGradientMode.Vertical)
        e.Cache.FillRectangle(backBrush, e.Bounds)
    End Using
    Dim innerRect As Rectangle = Rectangle.Inflate(e.Bounds, -2, -2)
    ' Draw the inner rectangle.
    Using backBrush = New LinearGradientBrush(e.Bounds, Color.Green, Color.LightGreen, LinearGradientMode.Vertical)
        e.Cache.FillRectangle(backBrush, innerRect)
    End Using
    ' Draw the header caption.
    e.Cache.DrawString(header.Caption, header.Appearance.HeaderCaption.Font, Brushes.White, innerRect, header.Appearance.HeaderCaption.GetStringFormat())
    e.Handled = True
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomDrawDayOfWeekHeader 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#

winforms-schedulercontrol-api-t224044/CS/SchedulerAPISample/CodeExamples/CustomDraw.cs#L135

#region #CustomDrawDayOfWeekHeaderEvent
scheduler.CustomDrawDayOfWeekHeader += scheduler_CustomDrawDayOfWeekHeader;
scheduler.ActiveViewType = SchedulerViewType.Month;

VB.NET

winforms-schedulercontrol-api-t224044/VB/SchedulerAPISample/CodeExamples/CustomDraw.vb#L127

'            #Region "#CustomDrawDayOfWeekHeaderEvent"
AddHandler scheduler.CustomDrawDayOfWeekHeader, AddressOf scheduler_CustomDrawDayOfWeekHeader
scheduler.ActiveViewType = SchedulerViewType.Month