SchedulerControl.FilterTimeRegion Event

Raised each time a time region is about to be displayed by the scheduler’s view and allows you to hide this time region.

Namespace: DevExpress.Xpf.Scheduling

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

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

Declaration

C#

public event FilterTimeRegionEventArgsHandler FilterTimeRegion

VB.NET

Public Event FilterTimeRegion As FilterTimeRegionEventArgsHandler

Event Data

The FilterTimeRegion event's data class is FilterTimeRegionEventArgs. The following properties provide information specific to this event:

Property	Description
Scheduler	The scheduler that raised the event.
TimeRegion	The time region for which the event is raised.
View	The scheduler’s view that raised the event.
Visible	Specifies whether to display the time region for which the event is raised.

Remarks

The TimeRegion property returns the time region for which the event is raised. Set the Visible property to false to hide this time region.

If the time region is hidden by the SchedulerControl.TimeRegionFilterCriteria or SchedulerControl.TimeRegionFilterString property, the event’s Visible property returns false. Set the Visible property to true to override the filter criteria/expression.

For regular occurrences, the FilterTimeRegion event is raised only once. In this scenario, the TimeRegion property returns the pattern.

Refer to the Filter Appointments and Time Regions topic for more information.

Related GitHub Examples

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

XAML

How-to-conditionally-show-and-hide-Time-Regions-in-Scheduler-Control/CS/DXSample/MainWindow.xaml#L40

CommandBarStyle="Ribbon"
FilterTimeRegion="{DXEvent Handler='@args.Visible = @args.TimeRegion.Interval.Duration.TotalHours > 23 or !(@args.View is $dxsch:MonthView)'}"
ShowDateNavigationPanel="True">