SchedulerControl.CustomDrawDayHeader Event
Enables day headers to be painted manually.
Namespace: DevExpress.XtraScheduler
Assembly: DevExpress.XtraScheduler.v18.2.dll
Declaration
public event CustomDrawObjectEventHandler CustomDrawDayHeaderPublic Event CustomDrawDayHeader As CustomDrawObjectEventHandlerEvent Data
The CustomDrawDayHeader 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 CustomDrawDayHeader event is raised before a day header is painted. The event parameter's CustomDrawObjectEventArgs.ObjectInfo property provides all the information necessary to paint a day header. The return value of this property should be typecast to the DayHeader type.
Set the CustomDrawObjectEventArgs.Handled property to true to prohibit default header painting.
You can paint object in a default manner before custom drawing. Use the CustomDrawObjectEventArgs.DrawDefault method for default drawing within event handler.
Examples
This example uses the code that paints day headers with blue gradient color, as illustrated in the image below.
NOTE
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-schedulercontrol-api-t224044
public static void scheduler_CustomDrawDayHeader(object sender, CustomDrawObjectEventArgs e)
{
DayHeader header = e.ObjectInfo as DayHeader;
// Draw the outer rectangle.
e.Cache.FillRectangle(new System.Drawing.Drawing2D.LinearGradientBrush(e.Bounds,
Color.LightBlue, Color.Blue, 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.Blue, Color.LightSkyBlue, 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;
}