SchedulerControl.RemoveAppointments(IEnumerable<AppointmentItem>, Boolean) Method
Removes the specified appointments from the AppointmentItems collection.
Namespace: DevExpress.Xpf.Scheduling
Assembly: DevExpress.Xpf.Scheduling.v24.1.dll
NuGet Package: DevExpress.Wpf.Scheduling
Declaration
public bool RemoveAppointments(
IEnumerable<AppointmentItem> appointments,
bool showDeleteOccurrenceWindow = false
)
Parameters
Name | Type | Description |
---|---|---|
appointments | IEnumerable<AppointmentItem> | A collection of DevExpress.Xpf.Scheduling.AppointmentItem objects to be removed from the AppointmentItems collection. |
Optional Parameters
Name | Type | Default | Description |
---|---|---|---|
showDeleteOccurrenceWindow | Boolean | False | true, to display the message box that notifies about removing occurrences; otherwise, false. |
Returns
Type | Description |
---|---|
Boolean | true, if the appointments have been removed from the AppointmentItems collection; otherwise, false. |
Remarks
The method does not add the specified appointment and returns false in either of the following cases:
- The appointments collection is empty
- The Cancel property of your AppointmentRemoving event implementation returns true.
See Also