SchedulerControl.DeleteAppointment(Appointment) Method

Deletes the specified appointment from the scheduler's storage.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v20.1.dll

Declaration

public void DeleteAppointment(
    Appointment apt
)
Public Sub DeleteAppointment(
    apt As Appointment
)

Parameters

Name Type Description
apt Appointment

An Appointment object that is the appointment to delete.

Remarks

The DeleteAppointment method performs different actions on the appointment according to its Appointment.Type. The following is a list of the possible appointment types and the actions which this method performs.

Appointment Type Action
Normal The appointment is removed from the AppointmentCollection.
Pattern The pattern appointment is removed from the AppointmentCollection. In this case, all the other recurring appointments in its series (appointments of the Occurrence, ChangedOccurrence and DeletedOccurrence types) will be also removed.
Occurrence The Appointment.Type of the appointment is changed to DeletedOccurrence, and this appointment is added to the pattern's exceptions collection which is returned via its Appointment.GetExceptions method.
ChangedOccurrence The Appointment.Type of the appointment is changed to DeletedOccurrence.
DeletedOccurrence This appointment is removed from the exceptions collection (returned via the Appointment.GetExceptions method) of the recurrence pattern, and the new Occurrence appointment is added in its place.

End-users can delete appointments by pressing the DEL key or using the context menu.

If an appointment exception is deleted, the Confirm Delete dialog is displayed (see the image below). This dialog allows you to select whether the current occurrence or all occurrences of the appointment should be deleted.

Scheduler_DeleteAppointment

See Also