SchedulerControl.AppointmentEditing Event

Occurs before the user applies changes to appointments.

Namespace: DevExpress.Xpf.Scheduling

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Scheduling, DevExpress.Wpf.Scheduling

Declaration

C#

public event AppointmentEditingEventHandler AppointmentEditing

VB.NET

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.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

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:

C#

 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
    } 
}

VB.NET

AddHandler AppointmentEditing, Sub(d, e)
    For Each apt In e.EditAppointments 'each appointment which is about to be edited
        Dim res As Boolean = Validate(apt) 'is validated by a custom method
        If Not res Then 'if the validation fails
            e.CanceledEditAppointments.Add(apt) 'the changes are not applied
        End If
    Next apt
End Sub

Related GitHub Examples

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

scheduler-crud-events/CS/Behaviors/SchedulerControlEditingBehavior.cs#L91

    AssociatedObject.AppointmentRemoving += AssociatedObject_AppointmentRemoving;
    AssociatedObject.AppointmentEditing += AssociatedObject_AppointmentEditing;
}

How-to-validate-appointment-items-on-adding-or-editing-them-in-SchedulerControl/CS/DXSample/ValidationClasses/SchedulerValidationService.cs#L53

var scheduler = this.AssociatedObject as SchedulerControl;
scheduler.AppointmentEditing += Scheduler_AppointmentEditing;
scheduler.AppointmentAdding += Scheduler_AppointmentAdding;

VB.NET

scheduler-crud-events/VB/Behaviors/SchedulerControlEditingBehavior.vb#L97

    AddHandler AssociatedObject.AppointmentRemoving, AddressOf AssociatedObject_AppointmentRemoving
    AddHandler AssociatedObject.AppointmentEditing, AddressOf AssociatedObject_AppointmentEditing
End Sub

How-to-validate-appointment-items-on-adding-or-editing-them-in-SchedulerControl/VB/DXSample/ValidationClasses/SchedulerValidationService.vb#L59

Dim scheduler = TryCast(Me.AssociatedObject, SchedulerControl)
AddHandler scheduler.AppointmentEditing, AddressOf Scheduler_AppointmentEditing
AddHandler scheduler.AppointmentAdding, AddressOf Scheduler_AppointmentAdding