DayOfWeekHeaders.CustomDrawDayOfWeekHeader Event

Enables the DayOfWeekHeaders control 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 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.
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 CustomDrawDayOfWeekHeader event is raised before a DayOfWeekHeaders control is printed. The event parameter’s CustomDrawObjectEventArgs.ObjectInfo property provides information on the visual element being painted. The return value of this property should be typecast to the DayOfWeekHeader 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 painting. Call the CustomDrawObjectEventArgs.DrawDefault method to perform the default drawing procedure if necessary.

The following code sample highlights the Wednesday header in shades of red.

C#

private void dayOfWeekHeaders1_CustomDrawDayOfWeekHeader(object sender, 
    CustomDrawObjectEventArgs e) {
    DayOfWeekHeader header = (DayOfWeekHeader)e.ObjectInfo;

    switch(header.DayOfWeek) {
        case DayOfWeek.Wednesday:
            header.Appearance.HeaderCaption.BackColor = Color.Red;
            header.Appearance.HeaderCaption.BackColor2 = Color.White;
            break;
    }
}

VB.NET

Private Sub dayOfWeekHeaders1_CustomDrawDayOfWeekHeader(ByVal sender As Object, _
        ByVal e As CustomDrawObjectEventArgs)  _
        Handles dayOfWeekHeaders1.CustomDrawDayOfWeekHeader
    Dim header As DayOfWeekHeader = CType(e.ObjectInfo, DayOfWeekHeader)

    Select Case header.DayOfWeek
        Case DayOfWeek.Wednesday
        header.Appearance.HeaderCaption.BackColor = Color.Red
        header.Appearance.HeaderCaption.BackColor2 = Color.White
    End Select
End Sub