SchedulerControl.AdditionalAppointmentsDrag Event

Occurs for the appointments added to the AppointmentDragEventArgs.AdditionalAppointments collection when they are dragged with the primary appointment.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v19.1.dll

Declaration

C#

public event EventHandler<AdditionalAppointmentsDragEventArgs> AdditionalAppointmentsDrag

VB.NET

Public Event AdditionalAppointmentsDrag As EventHandler(Of AdditionalAppointmentsDragEventArgs)

Event Data

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

Property	Description
AdditionalAppointmentInfos	Provides access to the properties of the additional dragged appointments.
PrimaryAppointmentInfos	Provides access to the properties of the primary dragged appointments.

Remarks

When an end-user drags an appointment, the SchedulerControl.AppointmentDrag event occurs for that appointment. Event data (the AppointmentDragEventArgs.AdditionalAppointments property) allows you to specify appointments which will be dragged with the primary appointment synchronously. When they are dragged, the AdditionalAppointmentsDrag event fires for each additional appointment. If an end-user presses ESC, both appointments return to the initial state.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-add-an-appointment-to-the-dragged-appointment-in-a-drag-and-drop-operation-t445652

Form1.cs

private void SchedulerControl_AppointmentDrag(object sender, AppointmentDragEventArgs e) {
    // Find a special appointment among visible appointments.
    AppointmentBaseCollection visbileApts = schedulerControl1.ActiveView.GetAppointments();
    Appointment apt = visbileApts.Find(item => (item.Subject == "Finalize" && item.ResourceId.Equals(e.HitResource.Id)));
    if (apt == null) {
        e.AdditionalAppointments.Clear();
    }
    else {
        if (e.SourceAppointment != apt) {
            // If the dragged appointment overlaps with the special appointment,
            // add the special appointment to the AdditionalAppointments collection
            // to drag along with the initial appointment.
            // The AdditionalAppointmentsDrag event will occur.
            if (e.EditedAppointment.End > apt.Start)
                e.AdditionalAppointments.Add(apt);
            else
                e.AdditionalAppointments.Clear();
        }
    }
}

private void SchedulerControl1_AdditionalAppointmentsDrag(object sender, AdditionalAppointmentsDragEventArgs e) {
    if (e.AdditionalAppointmentInfos.Count <= 0)
        return;
    AppointmentDragInfo aptInfo = e.AdditionalAppointmentInfos[0];
    // If the end of the main dragged appointment becomes greater than the start of the special appointment,
    // set the start of the special appointment being dragged to the end of the main dragged appointment.
    // It prevents overlapping appointments.
    if (e.PrimaryAppointmentInfos[0].EditedAppointment.End > aptInfo.SourceAppointment.Start)
        aptInfo.EditedAppointment.Start = e.PrimaryAppointmentInfos[0].EditedAppointment.End;
}

Form1.vb

Private Sub SchedulerControl_AppointmentDrag(ByVal sender As Object, ByVal e As AppointmentDragEventArgs)
    ' Find a special appointment among visible appointments.
    Dim visbileApts As AppointmentBaseCollection = schedulerControl1.ActiveView.GetAppointments()
    Dim apt As Appointment = visbileApts.Find(Function(item) (item.Subject = "Finalize" AndAlso item.ResourceId.Equals(e.HitResource.Id)))
    If apt Is Nothing Then
        e.AdditionalAppointments.Clear()
    Else
        If e.SourceAppointment IsNot apt Then
            ' If the dragged appointment overlaps with the special appointment,
            ' add the special appointment to the AdditionalAppointments collection
            ' to drag along with the initial appointment.
            ' The AdditionalAppointmentsDrag event will occur.
            If e.EditedAppointment.End > apt.Start Then
                e.AdditionalAppointments.Add(apt)
            Else
                e.AdditionalAppointments.Clear()
            End If
        End If
    End If
End Sub

Private Sub SchedulerControl1_AdditionalAppointmentsDrag(ByVal sender As Object, ByVal e As AdditionalAppointmentsDragEventArgs)
    If e.AdditionalAppointmentInfos.Count <= 0 Then
        Return
    End If
    Dim aptInfo As AppointmentDragInfo = e.AdditionalAppointmentInfos(0)
    ' If the end of the main dragged appointment becomes greater than the start of the special appointment,
    ' set the start of the special appointment being dragged to the end of the main dragged appointment.
    ' It prevents overlapping appointments.
    If e.PrimaryAppointmentInfos(0).EditedAppointment.End > aptInfo.SourceAppointment.Start Then
        aptInfo.EditedAppointment.Start = e.PrimaryAppointmentInfos(0).EditedAppointment.End
    End If
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AdditionalAppointmentsDrag 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-add-an-appointment-to-the-dragged-appointment-in-a-drag-and-drop-operation-t445652/CS/DragAppointmentExample/Form1.cs#L14

this.schedulerControl1.AppointmentDrag += SchedulerControl_AppointmentDrag;
this.schedulerControl1.AdditionalAppointmentsDrag += SchedulerControl1_AdditionalAppointmentsDrag;
#endregion #events

VB.NET

how-to-add-an-appointment-to-the-dragged-appointment-in-a-drag-and-drop-operation-t445652/VB/DragAppointmentExample/Form1.vb#L16

            AddHandler Me.schedulerControl1.AppointmentDrag, AddressOf SchedulerControl_AppointmentDrag
            AddHandler Me.schedulerControl1.AdditionalAppointmentsDrag, AddressOf SchedulerControl1_AdditionalAppointmentsDrag
'            #End Region ' #events