[Expand]General Information
[Collapse]WinForms Controls
  .NET Core Support
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Behaviors
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.DragDrop
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Filtering
  [Expand]DevExpress.Utils.Layout
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.MVVM
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Base
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.FluentDesignSystem
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.ToolbarForm
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Docking
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGantt
  [Expand]DevExpress.XtraGantt.Base.Scheduling
  [Expand]DevExpress.XtraGantt.Exceptions
  [Expand]DevExpress.XtraGantt.Localization
  [Expand]DevExpress.XtraGantt.Scheduling
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Converter
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Extensions
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Menu
  [Collapse]DevExpress.XtraScheduler
   [Expand]ActiveViewChangingEventArgs Class
    ActiveViewChangingEventHandler Delegate
   [Expand]AgendaView Class
   [Expand]AgendaViewAppearance Class
   [Expand]AppointmentDataStorage Class
   [Expand]AppointmentDependencyDataStorage Class
   [Expand]AppointmentDependencyFormEventArgs Class
    AppointmentDependencyFormEventHandler Delegate
   [Expand]AppointmentDependencyStorage Class
    AppointmentDisplayMode Enumeration
   [Expand]AppointmentDragDropOptions Class
   [Expand]AppointmentFlyoutOptions Class
   [Expand]AppointmentFlyoutShowingEventArgs Class
    AppointmentFlyoutShowingEventHandler Delegate
   [Expand]AppointmentFormEventArgs Class
    AppointmentFormEventHandler Delegate
   [Expand]AppointmentImagesEventArgs Class
    AppointmentImagesEventHandler Delegate
   [Expand]AppointmentLabel Class
   [Expand]AppointmentLabelCollection Class
   [Expand]AppointmentLabelDataStorage Class
   [Expand]AppointmentLabelExtension Class
   [Expand]AppointmentStatus Class
   [Expand]AppointmentStatusCollection Class
   [Expand]AppointmentStatusDataStorage Class
   [Expand]AppointmentStatusExtension Class
   [Expand]AppointmentStorage Class
   [Expand]AppointmentViewInfoCustomizingEventArgs Class
    AppointmentViewInfoCustomizingEventHandler Delegate
   [Expand]BaseHeaderAppearance Class
   [Expand]BaseViewAppearance Class
    BrushSavingType Enumeration
   [Expand]CustomDrawAppointmentFlyoutSubjectEventArgs Class
    CustomDrawAppointmentFlyoutSubjectEventHandler Delegate
   [Expand]CustomDrawObjectEventArgs Class
    CustomDrawObjectEventHandler Delegate
   [Expand]CustomizeAppointmentFlyoutEventArgs Class
    CustomizeAppointmentFlyoutEventHandler Delegate
   [Expand]CustomizeDateNavigationBarCaptionEventArgs Class
    DateNavigationMode Enumeration
   [Expand]DateNavigator Class
   [Expand]DayView Class
   [Expand]DayViewAppearance Class
   [Expand]DayViewAppointmentDisplayOptionsEx Class
   [Expand]DeleteRecurrentAppointmentFormEventArgs Class
    DeleteRecurrentAppointmentFormEventHandler Delegate
    DragDropMode Enumeration
    DXColorSavingType Enumeration
   [Expand]EditRecurrentAppointmentFormEventArgs Class
    EditRecurrentAppointmentFormEventHandler Delegate
   [Expand]FullWeekView Class
   [Expand]GanttView Class
   [Expand]GanttViewAppearance Class
   [Expand]GotoDateFormEventArgs Class
    GotoDateFormEventHandler Delegate
   [Expand]IAppointmentFlyoutData Interface
   [Expand]IAppointmentStorage Interface
   [Expand]InplaceEditorEventArgs Class
    InplaceEditorEventHandler Delegate
   [Expand]ISchedulerInplaceEditor Interface
   [Expand]ISchedulerStorage Interface
   [Expand]LabelMappingInfo Class
    LayoutElementKind Enumeration
   [Expand]LayoutViewInfoCustomizingEventArgs Class
   [Expand]MonthView Class
   [Expand]MonthViewAppearance Class
   [Expand]MonthViewAppointmentDisplayOptionsEx Class
   [Expand]PopupMenuShowingEventArgs Class
    PopupMenuShowingEventHandler Delegate
   [Expand]PrepareContextMenuEventArgs Class
    PrepareContextMenuEventHandler Delegate
   [Expand]PrepareFilterColumnEventArgs Class
    PrepareFilterColumnEventHandler Delegate
   [Expand]PreparePopupMenuEventArgs Class
    PreparePopupMenuEventHandler Delegate
   [Expand]RecurrentAppointmentActionFormEventArgs Class
   [Expand]RemindersFormEventArgs Class
    RemindersFormEventHandler Delegate
   [Expand]ResourceCategory Class
   [Expand]ResourceCategoryOptions Class
   [Expand]ResourceDataStorage Class
    ResourceDisplayStyle Enumeration
   [Expand]ResourceExtension Class
   [Expand]ResourceNavigator Class
   [Expand]ResourceStorage Class
   [Expand]ScaleBasedRangeControlClientOptions Class
   [Expand]SchedulerAppearance Class
    SchedulerColorId Enumeration
   [Expand]SchedulerColorSchema Class
   [Expand]SchedulerColorSchemaCollection Class
   [Expand]SchedulerControl Class
   [Expand]SchedulerDataStorage Class
   [Expand]SchedulerDateNavigationBar Class
   [Expand]SchedulerDeferredScrollingOption Class
   [Expand]SchedulerInplaceEditorEventArgs Class
   [Expand]SchedulerMenuCheckItem Class
   [Expand]SchedulerMenuItem Class
   [Expand]SchedulerOptionsBehavior Class
   [Expand]SchedulerOptionsPrint Class
   [Expand]SchedulerOptionsRangeControl Class
   [Expand]SchedulerOptionsView Class
   [Expand]SchedulerPopupMenu Class
   [Expand]SchedulerResourceHeaderOptions Class
   [Expand]SchedulerStorage Class
   [Expand]SchedulerViewBase Class
   [Expand]SchedulerViewRepository Class
    SchedulerViewStatusDisplayType Enumeration
   [Expand]ShowFormEventArgs Class
   [Expand]StatusMappingInfo Class
   [Expand]TimeIndicatorDisplayOptions Class
   [Expand]TimelineView Class
   [Expand]TimelineViewAppearance Class
   [Expand]TimelineViewAppointmentDisplayOptionsEx Class
   [Collapse]TimeRegion Class
     TimeRegion Members
     TimeRegion Constructor
    [Expand]TimeRegion Properties
   [Expand]TimeScaleWorkDay Class
   [Expand]TimeScaleWorkHour Class
   [Expand]WeekView Class
   [Expand]WeekViewAppearance Class
   [Expand]WeekViewAppointmentDisplayOptionsEx Class
   [Expand]WorkWeekView Class
   [Expand]WorkWeekViewAppearance Class
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.GoogleCalendar
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraTreeMap.Printing
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

TimeRegion Class

An area with unique user restrictions. Limits the appointments that can be placed inside this time interval and/or users that can add these appointments.

Namespace:DevExpress.XtraScheduler
Assembly:DevExpress.XtraScheduler.v19.2.dll

Expanded Syntax

Expanded Remarks

Appointment time regions are time slots with unique user restrictions that override global Scheduler settings. In the "Full Week" Scheduler demo time regions, disable the following time intervals for every week:

  • work days: 1p.m. - 2p.m;
  • weekends - disabled entirely.

In this demo users cannot create new appointments or change existing ones, so that they belong to these time regions. Appointments that already intersect these intervals cannot be edited either. These restrictions apply to all appointments except those with the "Out of Office" status.

Expanded Common Time Region Settings

Time Regions are objects of the TimeRegion class that are stored in the SchedulerControl.TimeRegions collection.

When it comes to settings, TimeRegion objects are similar to Appointments: they have start and end dates, and can recur according to the given pattern.

API

Description

Start
End

Date time values that specify the time region duration.

Recurrence

Stores the DevExpress.XtraScheduler.RecurrenceInfo object that specifies a recurrence rule (pattern) for this time region.

Editable

Specifies whether users can add, modify or remove appointments that belong (partially or completely) to this region.

You can use this boolean setting not only to "ban" a required date interval, but also to implement an editable region outside of which users cannot modify events. In the later case, disable the DevExpress.XtraScheduler.SchedulerOptionsCustomization.AllowAppointmentCreate, DevExpress.XtraScheduler.SchedulerOptionsCustomization.AllowAppointmentEdit and/or other global Scheduler settings, and set the Editable property to true.

ResourceIds

IDs of resources associated with this region.
Regions with resource IDs are displayed only for these resources when the SchedulerViewBase.GroupType is set to Resource.

ExceptionDates

A list of DateTime objects that allow you to remove a recurring time region instance for a specific date. Time portions of these DateTime objects must match the time of the Start value.

The code below illustrates how to create two above-mentioned time regions from the "Full Week" Scheduler demo.

Expanded Appearance

Time regions' appearance depends on the currently applied skin (and skin palette, if you use vector skins).

Handle the SchedulerControl.CustomDrawTimeRegion event to manually re-paint time regions. In the DevExpress demo this event is handled to draw a "lunch" icon on top of the 1p.m.~2p.m. region.

Expanded Custom Restrictions

When you disable the Editable setting, users are unable to create or modify existing appointments so that they belong to this region. Handle the SchedulerControl.TimeRegionCustomize event and override its e.Editable parameter to remove restrictions for specific appointments and/or users.

The code below is taken from the Scheduler Demo, where the "Lunch" time region (1p.m.~2p.m.) does not accept any appointments unless they have the "Out of Office" status.

Expanded Custom Appointment Edit Forms

The standard Appointment Edit Form does not allow you to set start/end appointment dates that belong to restricted time regions.

In case you use a custom Appointment Edit Form and implement custom methods that save appointments, check the return value of the boolean DevExpress.XtraScheduler.UI.AppointmentFormController.IsTimeValid method to prevent users from saving invalid appointments.

Change the SchedulerStringId.Msg_InvalidAppointmentTime field to replace the standard "Invalid appointment time" message.

Expanded Inheritance Hierarchy

System.Object
    TimeRegion

Expanded See Also

Is this topic helpful?​​​​​​​