A newer version of this page is available. Switch to the current version.

SchedulerControl.CustomDrawDayOfWeekHeader Event

Enables day of week headers to be painted manually.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v19.1.dll

Declaration

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

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.

Examples

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

CustomDrawDayOfWeekHeader_New

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

}
See Also