SchedulerStorage.FilterAppointment Event

Enables specific appointments to be hidden in the Scheduler Control.

Namespace: DevExpress.Xpf.Scheduler

Assembly: DevExpress.Xpf.Scheduler.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Scheduler, DevExpress.Wpf.Scheduler

Declaration

C#

public event PersistentObjectCancelEventHandler FilterAppointment

VB.NET

Public 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

Important

You are viewing documentation for the legacy WPF Scheduler control. If you’re starting a new project, we strongly recommend that you use a new control declared in the DevExpress.Xpf.Scheduling namespace. If you decide to upgrade an existing project in order to switch to the updated scheduler control, see the Migration Guidelines document.

You can handle the FilterAppointment event to hide specific appointments in the Scheduler control. This event fires each time the layout of the Scheduler control is modified (when the control is resized, when new appointments are added, or existing ones are modified, etc.). You can also force the layout to be updated by calling the SchedulerViewBase.LayoutChanged method.

The FilterAppointment event is raised for each appointment in the AppointmentStorage, in turn. If the PersistentObjectCancelEventArgs.Cancel parameter is set to true for the currently processed appointment, then this appointment will be hidden in the Scheduler control.

Note

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

Example

This example demonstrates how to use the SchedulerStorage.FilterAppointment event to filter appointments shown within a Scheduler Control, according to specific conditions. Specifically, the code below hides all tentative appointments (those whose status is set to AppointmentStatusType.Tentative).

C#

using DevExpress.XtraScheduler;
// ...

private void SchedulerStorage_FilterAppointment(object sender, PersistentObjectCancelEventArgs e) {
    // Filter all tentative appointments.
    e.Cancel = Convert.ToInt32(((Appointment)e.Object).StatusKey) == 1;
}

VB.NET

Imports Microsoft.VisualBasic
Imports DevExpress.XtraScheduler
' ...

Private Sub SchedulerStorage_FilterAppointment(sender As System.Object, _
                                               e As PersistentObjectCancelEventArgs)
    ' Filter all tentative appointments.
    e.Cancel = Convert.ToInt32(DirectCast(e.[Object], Appointment).StatusKey) = 1
End Sub

XAML

<dxsch:SchedulerControl.Storage>
    <dxsch:SchedulerStorage FilterAppointment="SchedulerStorage_FilterAppointment"/>
</dxsch:SchedulerControl.Storage>

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#

wpf-schedulercontrol-api-t442105/CS/SchedulerControl_WPF_API/CodeExamples/AppointmentExamples.cs#L38

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

VB.NET

wpf-schedulercontrol-api-t442105/VB/SchedulerControl_WPF_API/CodeExamples/AppointmentExamples.vb#L38

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