AppointmentImagesEventArgs Class

Provides data for the SchedulerControl.InitAppointmentImages event.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v24.2.dll

Declaration

C#

public class AppointmentImagesEventArgs :
    EventArgs

VB.NET

Public Class AppointmentImagesEventArgs
    Inherits EventArgs

Related API Members

AppointmentImagesEventArgs is the data class for the following events:

• SchedulerControl.InitAppointmentImages
• TimeCellsControlBase.InitAppointmentImages

Remarks

The SchedulerControl.InitAppointmentImages event occurs before an appointment is painted when its images are initialized. The AppointmentImagesEventArgs class introduces the AppointmentImagesEventArgs.ImageInfoList property that specifies the images to be displayed within the appointment. The processed appointment is identified by the AppointmentEventArgs.Appointment property.

Note, that AppointmentImagesEventArgs objects are automatically created, initialized and passed to SchedulerControl.InitAppointmentImages event handlers.

Example

The following example handles the SchedulerControl.InitAppointmentImages event to display a custom image within the exception appointment.

The image below shows the result:

C#

using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.Drawing;
// ...

private void schedulerControl1_InitAppointmentImages(object sender, AppointmentImagesEventArgs e) {
    if(e.Appointment.IsException) {
        AppointmentImageInfo info = new AppointmentImageInfo();
        info.Image = SystemIcons.Warning.ToBitmap();
        e.ImageInfoList.Add(info);
    }
}

VB.NET

Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.Drawing
' ...

Private Sub SchedulerControl1_InitAppointmentImages(ByVal sender As Object, ByVal e As _
AppointmentImagesEventArgs) Handles SchedulerControl1.InitAppointmentImages
   If e.Appointment.IsException Then
      Dim info As AppointmentImageInfo = New AppointmentImageInfo()
      info.Image = SystemIcons.Warning.ToBitmap()
      e.ImageInfoList.Add(info)
   End If
End Sub

Inheritance

Object

EventArgs

AppointmentImagesEventArgs