SchedulerControl.CustomDrawGroupSeparator Event

Enables group separators to be painted manually.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v18.2.dll

Declaration

C#

public event CustomDrawObjectEventHandler CustomDrawGroupSeparator

VB.NET

Public Event CustomDrawGroupSeparator As CustomDrawObjectEventHandler

Event Data

The CustomDrawGroupSeparator 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 CustomDrawGroupSeparator event occurs before a group separator is painted. The event parameter’s CustomDrawObjectEventArgs.ObjectInfo property provides required information to paint the group separator.

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 separator painting.

Example

The following code draws a custom image in the Group Separator bar.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-schedulercontrol-api-t224044

CustomDraw.cs

public static void scheduler_CustomDrawGroupSeparator(object sender, DevExpress.XtraScheduler.CustomDrawObjectEventArgs e)
{
    e.DrawDefault();
    Image im = Image.FromFile("image.png");
    Rectangle imageBounds = new Rectangle(e.Bounds.X - (im.Width / 2), e.Bounds.Y, im.Width, im.Height);
    e.Cache.Graphics.DrawImage(im, imageBounds);
    e.Handled = true;
}

CustomDraw.vb

Public Shared Sub scheduler_CustomDrawGroupSeparator(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.CustomDrawObjectEventArgs)
    e.DrawDefault()
    Dim im As Image = Image.FromFile("image.png")
    Dim imageBounds As New Rectangle(e.Bounds.X - (im.Width \ 2), e.Bounds.Y, im.Width, im.Height)
    e.Cache.Graphics.DrawImage(im, imageBounds)
    e.Handled = True
End Sub

Related GitHub Examples

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

#region #CustomDrawGroupSeparatorEvent
scheduler.CustomDrawGroupSeparator += scheduler_CustomDrawGroupSeparator;
scheduler.GroupType = SchedulerGroupType.Resource;

VB.NET

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

'            #Region "#CustomDrawGroupSeparatorEvent"
AddHandler scheduler.CustomDrawGroupSeparator, AddressOf scheduler_CustomDrawGroupSeparator
scheduler.GroupType = SchedulerGroupType.Resource