Skip to main content

SchedulerControl.CustomDrawTabHeader Event

Allows you to paint resource tab headers.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v23.2.dll

NuGet Package: DevExpress.Win.Scheduler

Declaration

public event CustomDrawObjectEventHandler CustomDrawTabHeader

Event Data

The CustomDrawTabHeader 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 Scheduler control displays resources as tabs if the ResourceDisplayStyle property is set to ResourceDisplayStyle.Tabs. The Scheduler control fires the CustomDrawTabHeader event for each resource tab. Handle this event to paint tab headers.

Set the e.Handled property to true to custom paint the resource tabs and prevent default painting.

using DevExpress.XtraScheduler.Drawing;

private void schedulerControl_CustomDrawTabHeader(object sender, CustomDrawObjectEventArgs e) {
    SchedulerHeaderTab header = e.ObjectInfo as SchedulerHeaderTab;
    if(header.Caption == schedulerControl.ActiveView.SelectedResource.Caption) {
        /*
         * Custom paint the selected tab header.
         */
        e.Handled = true;
    }
}
See Also