SchedulerControl.AppointmentDrag Event

Occurs when appointment is dragged in the Scheduler control.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v20.2.dll

NuGet Package: DevExpress.Win.Scheduler

Declaration

C#

public event AppointmentDragEventHandler AppointmentDrag

VB.NET

Public Event AppointmentDrag As AppointmentDragEventHandler

Event Data

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

Property	Description
AdditionalAppointments	Provides access to the collection of the additional dragged appointments.
Allow	Specifies whether the appointment can be dragged along the time cells.
CopyEffect	Indicates whether the drop effect in a drag-and-drop appointment operation is Copy.
EditedAppointment	Gets the appointment being modified in the drag-and-drop event.
ForceUpdateFromStorage	Gets or sets whether the View is forced to query appointments from the storage.
HitInterval	Gets the time interval represented by the time cell to which an appointment was dragged.
HitResource	Gets the resource to which an appointment was dragged.
NewAppointmentResourceIds	Gets or sets the IDs of resources for a new appointment.
SourceAppointment	Gets the source appointment in the drag-and-drop event.

Remarks

If a user drags multiple appointments, this event fires for each of them.

The AdditionalAppointments property in event parameters allows you to re-arrange other appointments that were not dragged by a user. In the sample below, if a user is about to schedule the “Start” appointment so that it finishes later in time than the related “Finish” appointment starts, the latter appointment is added to the AdditionalAppointments collection.

C#

void SchedulerControl1_AppointmentDrag(object sender, AppointmentDragEventArgs e) {
    if (e.SourceAppointment.Subject == "Start") {
        AppointmentBaseCollection visbileApts = schedulerControl1.ActiveView.GetAppointments();
        Appointment apt = visbileApts.Find(item => item.Subject == "Finish");
        if (apt == null)
            e.AdditionalAppointments.Clear();
        else {
            if (e.SourceAppointment != apt) {
                if (e.EditedAppointment.End > apt.Start)
                    e.AdditionalAppointments.Add(apt);
                else e.AdditionalAppointments.Clear(); 
            }
        }
    }
}

VB.NET

Private Sub SchedulerControl1_AppointmentDrag(ByVal sender As Object, ByVal e As AppointmentDragEventArgs)
    If e.SourceAppointment.Subject = "Start" Then
        Dim visbileApts As AppointmentBaseCollection = schedulerControl1.ActiveView.GetAppointments()
        Dim apt As Appointment = visbileApts.Find(Function(item) item.Subject = "Finish")
        If apt Is Nothing Then
            e.AdditionalAppointments.Clear()
        Else
            If e.SourceAppointment IsNot apt Then
                If e.EditedAppointment.End > apt.Start Then
                    e.AdditionalAppointments.Add(apt)
                Else
                    e.AdditionalAppointments.Clear()
                End If
            End If
        End If
    End If
End Sub

To specify new positions for AdditionalAppointments, handle the SchedulerControl.AppointmentsDrag event.

C#

private void SchedulerControl1_AppointmentsDrag(object sender, DevExpress.XtraScheduler.AppointmentsDragEventArgs e) {
    if (e.AdditionalAppointmentInfos.Count <= 0)
        return;
    AppointmentDragInfo aptInfo = e.AdditionalAppointmentInfos[0];
    if (e.PrimaryAppointmentInfos[0].EditedAppointment.End > aptInfo.SourceAppointment.Start)
        aptInfo.EditedAppointment.Start = e.PrimaryAppointmentInfos[0].EditedAppointment.End;
}

VB.NET

Private Sub SchedulerControl1_AppointmentsDrag(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.AppointmentsDragEventArgs)
    If e.AdditionalAppointmentInfos.Count <= 0 Then
        Return
    End If
    Dim aptInfo As AppointmentDragInfo = e.AdditionalAppointmentInfos(0)
    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 snippets (auto-collected from DevExpress Examples) contain references to the AppointmentDrag 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-implement-precise-drag-and-drop-and-resizing-of-appointments-in-day-work-week-view-e4497/CS/OneMinuteDragDrop/Handlers/AppointmentsDragHandler.cs#L28

    control.AppointmentDrop += AppointmentDropHandler;
    control.AppointmentDrag += AppointmentDragHandler;
}

how-to-paint-a-special-time-area-for-an-appointment-and-interact-with-it-t246714/CS/T246714/Form1.cs#L24

schedulerControl1.CustomDrawAppointment += schedulerControl1_CustomDrawAppointment;
schedulerControl1.AppointmentDrag += schedulerControl1_AppointmentDrag;
schedulerControl1.AppointmentDrop += schedulerControl1_AppointmentDrop;

appointment-drag-and-drop-to-datenavigator-e3893/CS/DragDropDateNavigator/Form1.cs#L32

schedulerControl1.Start = DateTime.Now;
schedulerControl1.AppointmentDrag += new AppointmentDragEventHandler(schedulerControl1_AppointmentDrag);
schedulerControl1.GroupType = SchedulerGroupType.None;

how-to-add-an-appointment-to-the-dragged-appointment-in-a-drag-and-drop-operation-t445652/CS/DragAppointmentExample/Form1.cs#L13

// Subscribe to events
this.schedulerControl1.AppointmentDrag += SchedulerControl_AppointmentDrag;
this.schedulerControl1.AdditionalAppointmentsDrag += SchedulerControl1_AdditionalAppointmentsDrag;

VB.NET

how-to-implement-precise-drag-and-drop-and-resizing-of-appointments-in-day-work-week-view-e4497/VB/OneMinuteDragDrop/Handlers/AppointmentsDragHandler.vb#L35

    AddHandler control.AppointmentDrop, AddressOf AppointmentDropHandler
    AddHandler control.AppointmentDrag, AddressOf AppointmentDragHandler
End Sub

how-to-paint-a-special-time-area-for-an-appointment-and-interact-with-it-t246714/VB/T246714/Form1.vb#L26

AddHandler schedulerControl1.CustomDrawAppointment, AddressOf schedulerControl1_CustomDrawAppointment
AddHandler schedulerControl1.AppointmentDrag, AddressOf schedulerControl1_AppointmentDrag
AddHandler schedulerControl1.AppointmentDrop, AddressOf schedulerControl1_AppointmentDrop

appointment-drag-and-drop-to-datenavigator-e3893/VB/DragDropDateNavigator/Form1.vb#L30

schedulerControl1.Start = Date.Now
AddHandler schedulerControl1.AppointmentDrag, AddressOf schedulerControl1_AppointmentDrag
schedulerControl1.GroupType = SchedulerGroupType.None

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

' Subscribe to events
AddHandler Me.schedulerControl1.AppointmentDrag, AddressOf SchedulerControl_AppointmentDrag
AddHandler Me.schedulerControl1.AdditionalAppointmentsDrag, AddressOf SchedulerControl1_AdditionalAppointmentsDrag