A newer version of this page is available. Switch to the current version.

CustomDrawObjectEventArgs Class

Provides data for the custom draw events of the SchedulerControl.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v19.1.dll

Declaration

public class CustomDrawObjectEventArgs :
    EventArgs
Public Class CustomDrawObjectEventArgs
    Inherits EventArgs

Remarks

The custom draw events occur before any scheduler element is painted. The CustomDrawObjectEventArgs class introduces several properties to represent all objects necessary to implement the custom drawing of a scheduler element.

If CustomDrawObjectEventArgs.Handled is set to true, the default painting is not performed after the handler code execution. Use CustomDrawObjectEventArgs.DrawDefault method in the handler code to render the element using the default drawing mechanism.

NOTE

When handling custom draw events in Scheduler Reporting, use only CustomDrawObjectEventArgs.Cache or e.Cache.Paint methods. Do not use CustomDrawObjectEventArgs.Graphics methods.

Examples

The following sample code handles the SchedulerControl.CustomDrawAppointment event to manually paint appointments. The image below shows the result.

CustomDrawAppointment

using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.Drawing;
using System.Drawing.Drawing2D;
        private void schedulerControl1_CustomDrawAppointment(object sender, CustomDrawObjectEventArgs e) {
            TimeLineAppointmentViewInfo tlvi = e.ObjectInfo as TimeLineAppointmentViewInfo;
            // This code works only for the Timeline View.
            if(tlvi != null) {
                Rectangle r = e.Bounds;
                r.X += 3;
                r.Y += 3;
                string[] s = tlvi.Appointment.Subject.Split(' ');

                for(int i = 0; i < s.Length; i++) {
                    e.Cache.DrawString(s[i], tlvi.Appearance.Font, new SolidBrush(colorArray[i]),
 r, StringFormat.GenericDefault);
                    SizeF shift = e.Graphics.MeasureString(s[i] + " ", tlvi.Appearance.Font);
                    r.X += (int)shift.Width;
                }

                e.Handled = true;
            }
        }

Inheritance

See Also