SchedulerControl.CustomizeAppointmentFlyout Event

Occurs before displaying an appointment flyout and allows you to change the displayed text, background and the subject’s font. Precedes the SchedulerControl.CustomDrawAppointmentFlyoutSubject event.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v18.2.dll

Declaration

C#

public event CustomizeAppointmentFlyoutEventHandler CustomizeAppointmentFlyout

VB.NET

Public Event CustomizeAppointmentFlyout As CustomizeAppointmentFlyoutEventHandler

Event Data

The CustomizeAppointmentFlyout event's data class is CustomizeAppointmentFlyoutEventArgs. The following properties provide information specific to this event:

Property	Description
Appearance	Provides access to an object used to control the appearance of the flyout contents, except the Subject rectangle.
Appointment	Provides access to an appointment for which the flyout is invoked.
End	Gets or sets the DateTime value displayed after the End text label.
Location	Gets or sets the text displayed after the Location text label.
Reminder	Gets or sets a reminder whose information is displayed in the appointment flyout.
ShowEndDate	Gets or sets whether to display the End information.
ShowLocation	Gets or sets whether to display the Location information.
ShowReminder	Gets or sets whether to display the time before start information of the appointment reminder.
ShowStartDate	Gets or sets whether to display the Start information.
ShowStatus	Gets or sets whether to display the status line.
ShowSubject	Gets or sets whether to display the Subject rectangle.
Start	Gets or sets the DateTime value displayed after the Start text label.
Subject	Gets or sets the text displayed in the Subject rectangle.
SubjectAppearance	Provides access to an object used to specify the appearance of the text in the Subject rectangle of the appointment flyout.

Remarks

By handling the CustomizeAppointmentFlyout event, you can change the text displayed in the flyout, specify the background color and the font used to display the information. You can also specify whether to display the status line in the Subject rectangle and whether to show the Subject rectangle itself.

If the SchedulerOptionsCustomization.AllowDisplayAppointmentFlyout property is false, this event does not occur.

Example

This example demonstrates how to customize the Appointment Flyout element. It handles two events - the SchedulerControl.CustomizeAppointmentFlyout event, which allows you to change flyout texts, and the SchedulerControl.CustomDrawAppointmentFlyoutSubject event, which enables you to perform custom drawing in the flyout’s subject rectangle.

Note

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

CustomDraw.cs

    scheduler.ActiveViewType = SchedulerViewType.FullWeek;
    scheduler.CustomizeAppointmentFlyout += scheduler_CustomizeAppointmentFlyout;
    scheduler.CustomDrawAppointmentFlyoutSubject+= scheduler_CustomDrawAppointmentFlyoutSubject;
static Font fnt = new Font("Segoe UI", 10f);
public static void scheduler_CustomizeAppointmentFlyout(object sender, CustomizeAppointmentFlyoutEventArgs e) {
    e.ShowSubject = true;
    e.Subject = String.Format("{0} - {1:f}", e.Subject.Split()[0], e.Start);
    e.SubjectAppearance.Font = fnt;
    e.ShowReminder = false;
    e.ShowLocation = false;
    e.ShowEndDate = false;
    e.ShowStartDate = false;
    e.ShowStatus = true;
    e.Appearance.BackColor = Color.Gray;
}
static Font fnt1 = new Font("Verdana", 12f);
public static void scheduler_CustomDrawAppointmentFlyoutSubject(object sender, CustomDrawAppointmentFlyoutSubjectEventArgs e) {
    e.Cache.FillRectangle(Brushes.White, e.Bounds);
    e.DrawStatusDefault();
    e.Cache.DrawString("Please note", fnt1, Brushes.Blue, 
        new Rectangle(e.Bounds.X + 50, e.Bounds.Y, e.Bounds.Width, e.Bounds.Height),
        StringFormat.GenericTypographic);
    e.Handled = true;
}

CustomDraw.vb

    scheduler.ActiveViewType = SchedulerViewType.FullWeek
    AddHandler scheduler.CustomizeAppointmentFlyout, AddressOf scheduler_CustomizeAppointmentFlyout
    AddHandler scheduler.CustomDrawAppointmentFlyoutSubject, AddressOf scheduler_CustomDrawAppointmentFlyoutSubject
Shared fnt As Font = New Font("Segoe UI", 10.0F)
Public Shared Sub scheduler_CustomizeAppointmentFlyout(ByVal sender As Object, ByVal e As CustomizeAppointmentFlyoutEventArgs)
    e.ShowSubject = True
    e.Subject = String.Format("{0} - {1:f}", e.Subject.Split()(0), e.Start)
    e.SubjectAppearance.Font = fnt
    e.ShowReminder = False
    e.ShowLocation = False
    e.ShowEndDate = False
    e.ShowStartDate = False
    e.ShowStatus = True
    e.Appearance.BackColor = Color.Gray
End Sub
Shared fnt1 As Font = New Font("Verdana", 12.0F)
Public Shared Sub scheduler_CustomDrawAppointmentFlyoutSubject(ByVal sender As Object, ByVal e As CustomDrawAppointmentFlyoutSubjectEventArgs)
    e.Cache.FillRectangle(Brushes.White, e.Bounds)
    e.DrawStatusDefault()
    e.Cache.DrawString("Please note", fnt1, Brushes.Blue, New Rectangle(e.Bounds.X + 50, e.Bounds.Y, e.Bounds.Width, e.Bounds.Height), StringFormat.GenericTypographic)
    e.Handled = True
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomizeAppointmentFlyout 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#

how-to-customize-the-appointment-flyout-t579967/CS/CustomAppointmentFlyoutExample/Form1.cs#L125

if (chkBtnCustomizeAppointmentFlyout.Checked)
    schedulerControl1.CustomizeAppointmentFlyout += OnSchedulerControlCustomizeAppointmentFlyout;
else

winforms-schedulercontrol-api-t224044/CS/SchedulerAPISample/CodeExamples/CustomDraw.cs#L391

scheduler.ActiveViewType = SchedulerViewType.FullWeek;
scheduler.CustomizeAppointmentFlyout += scheduler_CustomizeAppointmentFlyout;
scheduler.CustomDrawAppointmentFlyoutSubject += scheduler_CustomDrawAppointmentFlyoutSubject;

VB.NET

how-to-customize-the-appointment-flyout-t579967/VB/CustomAppointmentFlyoutExample/Form1.vb#L126

If chkBtnCustomizeAppointmentFlyout.Checked Then
    AddHandler schedulerControl1.CustomizeAppointmentFlyout, AddressOf OnSchedulerControlCustomizeAppointmentFlyout
Else

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

scheduler.ActiveViewType = SchedulerViewType.FullWeek
AddHandler scheduler.CustomizeAppointmentFlyout, AddressOf scheduler_CustomizeAppointmentFlyout
AddHandler scheduler.CustomDrawAppointmentFlyoutSubject, AddressOf scheduler_CustomDrawAppointmentFlyoutSubject