SchedulerControl.CustomDrawResourceHeader Event
Enables resource headers to be painted manually.
Namespace: DevExpress.XtraScheduler
Assembly: DevExpress.XtraScheduler.v18.2.dll
Declaration
public event CustomDrawObjectEventHandler CustomDrawResourceHeaderPublic Event CustomDrawResourceHeader As CustomDrawObjectEventHandlerEvent Data
The CustomDrawResourceHeader 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 CustomDrawResourceHeader event fires before a resource header is painted. The event parameter's CustomDrawObjectEventArgs.ObjectInfo property provides all the information necessary to paint a resource header. The return value of this property should be typecast to the ResourceHeader type.
You can call the CustomDrawObjectEventArgs.DrawDefault method to perform default painting before applying custom draw.
Set the CustomDrawObjectEventArgs.Handled property to true to prohibit default header painting.
Examples
This example illustrates how to display multi-line captions in resource headers. The caption text includes information obtained from the resource's custom fields.
NOTE
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-schedulercontrol-api-t224044
public static void scheduler_CustomDrawResourceHeader(object sender, DevExpress.XtraScheduler.CustomDrawObjectEventArgs e)
{
ResourceHeader header = (ResourceHeader)e.ObjectInfo;
// Get the resource information from custom fields.
string postcode = (header.Resource.CustomFields["PostCode"] != null) ? header.Resource.CustomFields["PostCode"].ToString() : String.Empty;
string address = (header.Resource.CustomFields["Address"] != null) ? header.Resource.CustomFields["Address"].ToString() : String.Empty;
// Specify the header caption and appearance.
header.Appearance.HeaderCaption.ForeColor = Color.Blue;
header.Caption = header.Resource.Caption + System.Environment.NewLine + address + System.Environment.NewLine + postcode;
header.Appearance.HeaderCaption.Font = e.Cache.GetFont(header.Appearance.HeaderCaption.Font, FontStyle.Bold);
// Draw the header using default methods.
e.DrawDefault();
e.Handled = true;
}