Back to Devexpress

SchedulerControl.RemoveAppointments(IEnumerable<AppointmentItem>, Boolean) Method

wpf-devexpress-dot-xpf-dot-scheduling-dot-schedulercontrol-dot-removeappointments-x28-system-dot-collections-dot-generic-dot-ienumerable-devexpress-dot-xpf-dot-scheduling-dot-appointmentitem-system-dot-boolean-x29.md

latest2.6 KB
Original Source

SchedulerControl.RemoveAppointments(IEnumerable<AppointmentItem>, Boolean) Method

Removes the specified appointments from the AppointmentItems collection.

Namespace : DevExpress.Xpf.Scheduling

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

NuGet Package : DevExpress.Wpf.Scheduling

Declaration

csharp
public bool RemoveAppointments(
    IEnumerable<AppointmentItem> appointments,
    bool showDeleteOccurrenceWindow = false
)
vb
Public Function RemoveAppointments(
    appointments As IEnumerable(Of AppointmentItem),
    showDeleteOccurrenceWindow As Boolean = False
) As Boolean

Parameters

NameTypeDescription
appointmentsIEnumerable<AppointmentItem>

A collection of DevExpress.Xpf.Scheduling.AppointmentItem objects to be removed from the AppointmentItems collection.

|

Optional Parameters

NameTypeDefaultDescription
showDeleteOccurrenceWindowBooleanFalse

true, to display the message box that notifies about removing occurrences; otherwise, false.

|

Returns

TypeDescription
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

SchedulerControl Class

SchedulerControl Members

DevExpress.Xpf.Scheduling Namespace