SchedulerControl.CustomDrawResourceHeader Event

Enables resource headers to be painted manually.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v18.2.dll

Declaration

C#

public event CustomDrawObjectEventHandler CustomDrawResourceHeader

VB.NET

Public Event CustomDrawResourceHeader As CustomDrawObjectEventHandler

Event 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.

Example

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

CustomDraw.cs

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;
}

CustomDraw.vb

Public Shared Sub scheduler_CustomDrawResourceHeader(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.CustomDrawObjectEventArgs)
    Dim header As ResourceHeader = CType(e.ObjectInfo, ResourceHeader)
    ' Get the resource information from custom fields.
    Dim postcode As String = If(header.Resource.CustomFields("PostCode") IsNot Nothing, header.Resource.CustomFields("PostCode").ToString(), String.Empty)
    Dim address As String = If(header.Resource.CustomFields("Address") IsNot Nothing, 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
End Sub

Related GitHub Examples

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

scheduler.GroupType = SchedulerGroupType.Resource;
scheduler.CustomDrawResourceHeader += scheduler_CustomDrawResourceHeader;
#endregion #CustomDrawResourceHeaderEvent

VB.NET

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

scheduler.GroupType = SchedulerGroupType.Resource
AddHandler scheduler.CustomDrawResourceHeader, AddressOf scheduler_CustomDrawResourceHeader
'            #End Region ' #CustomDrawResourceHeaderEvent