ISchedulerStorageBase.FilterAppointment Event

Hides specific appointments in the Scheduler control.

Namespace: DevExpress.XtraScheduler

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

Declaration

C#

event PersistentObjectCancelEventHandler FilterAppointment

VB.NET

Event FilterAppointment As PersistentObjectCancelEventHandler

Event Data

The FilterAppointment 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

Handle the FilterAppointment event to hide specific appointments in the Scheduler control. This event fires each time the layout of the Scheduler control changes (on resizing the control, adding a new appointment, modifying existing appointments, etc.) You can also force the layout update by calling the SchedulerViewBase.LayoutChanged method.

The FilterAppointment event occurs for each appointment in the Appointments storage, in turn. If the PersistentObjectCancelEventArgs.Cancel parameter is set to true for the currently processed appointment, then the Scheduler control does not display this appointment.

Note

This event allows you to specify appointments for display. Do not modify appointment properties, and do not add or remove appointments within this event handler. An attempt to do so may result in an unhandled exception.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FilterAppointment 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#

winforms-schedulercontrol-api-t224044/CS/SchedulerAPISample/CodeExamples/AppointmentExamples.cs#L35

// Handle the FilterAppointment event to display appointments by some criteria.
scheduler.DataStorage.FilterAppointment += Storage_FilterAppointment;
scheduler.DayView.TopRowTime = TimeSpan.FromHours(DateTime.Now.Hour);

VB.NET

winforms-schedulercontrol-api-t224044/VB/SchedulerAPISample/CodeExamples/AppointmentExamples.vb#L35

' Handle the FilterAppointment event to display appointments by some criteria.
AddHandler scheduler.DataStorage.FilterAppointment, AddressOf Storage_FilterAppointment
scheduler.DayView.TopRowTime = TimeSpan.FromHours(Date.Now.Hour)