All docs
V20.1
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

SchedulerControl.AppointmentEditing Event

Occurs before the user applies changes to appointments.

Namespace: DevExpress.Xpf.Scheduling

Assembly: DevExpress.Xpf.Scheduling.v20.1.dll

Declaration

public event AppointmentEditingEventHandler AppointmentEditing
Public Event AppointmentEditing As AppointmentEditingEventHandler

Event Data

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

Property Description
Cancel Gets or sets whether the event should be canceled. Inherited from CancelRoutedEventArgs.
CanceledEditAppointments Provides access to the collection of appointments for which changes should be canceled.
ConflictedAppointments Returns the collection of edited appointments that are conflicting with the current appointments.
EditAppointments Provides access to the collection of edited appointments.
Handled Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.
SourceAppointments Provides access to the collection of appointments before the changes the user attempts to apply.

Remarks

To prevent specific appointments from being edited, add them to the CanceledAppointments collection.

The event's SourceAppointments property returns the collection of appointments before the changes the user attempts to apply. If the event's Cancel property is set to false, the edited appointments stored in the EditAppointments collection are saved to SchedulerControl.AppointmentItems.

To implement custom editing, set the event's Cancel property to true and manually populate the AppointmentEditingEventArgs.SourceAppointments collection.

The code snippet below demonstrates how to implement validation:

 AppointmentEditing += (d, e) => { 
    foreach(var apt in e.EditAppointments) { //each appointment which is about to be edited
        bool res = Validate(apt); //is validated by a custom method 
        if(!res) //if the validation fails 
            e.CanceledEditAppointments.Add(apt); //the changes are not applied
    } 
}
See Also