SchedulerStorageBase.AppointmentChanging Event

Fires when an appointment’s property is about to change.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v19.2.Core.dll

Declaration

C#

public event PersistentObjectCancelEventHandler AppointmentChanging

VB.NET

Public Event AppointmentChanging As PersistentObjectCancelEventHandler

Event Data

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

Property	Description
Cancel	Gets or sets whether to cancel the operation.
Object	Gets the persistent object (appointment, resource or appointment dependency) for which the event occurs. Inherited from PersistentObjectEventArgs.

Remarks

The AppointmentChanging event is raised when changing an appointment’s property. The appointment whose property is changed is identified by the event parameter’s PersistentObjectEventArgs.Object property. Set the PersistentObjectCancelEventArgs.Cancel to true to roll back changes and cancel the operation.

When an appointment in a series of recurring appointments changes, the AppointmentChanging event fires twice. The first time it is raised for the appointment occurrence. Do not change custom fields when the event is raised for the first time. The next time the event is raised for the changed occurrence and you can modify custom fields if required.

Important

Do not modify the appointment’s data source or data binding within this event handler. It results in the current appointment being disposed of, and consequently, an unhandled exception occurs.

Example

This event handler restricts the end-user from modifying appointments with busy status.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-use-custom-appointment-fields-in-a-custom-editing-form-e2782

Form1.cs

private void SchedulerStorage1_AppointmentChanging(object sender, PersistentObjectCancelEventArgs e) {
    object busyKey = schedulerStorage1.Appointments.Statuses.GetByType(AppointmentStatusType.Busy).Id;
    if (((Appointment)e.Object).StatusKey == busyKey) e.Cancel = true;
}

Form1.vb

Private Sub SchedulerStorage1_AppointmentChanging(ByVal sender As Object, ByVal e As PersistentObjectCancelEventArgs)
    Dim busyKey As Object = schedulerStorage1.Appointments.Statuses.GetByType(AppointmentStatusType.Busy).Id
    If CType(e.Object, Appointment).StatusKey Is busyKey Then
        e.Cancel = True
    End If
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AppointmentChanging 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-paint-a-special-time-area-for-an-appointment-and-interact-with-it-t246714/CS/T246714/Form1.cs#L55

    schedulerStorage1.AppointmentInserting +=schedulerStorage1_AppointmentInserting;
    schedulerStorage1.AppointmentChanging += schedulerStorage1_AppointmentChanging;
}

VB.NET

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

    AddHandler schedulerStorage1.AppointmentInserting, AddressOf schedulerStorage1_AppointmentInserting
    AddHandler schedulerStorage1.AppointmentChanging, AddressOf schedulerStorage1_AppointmentChanging
End Sub

Implements

AppointmentChanging