Back to Devexpress

DevExpress.XtraScheduler Namespace

corelibraries-devexpress-76e8e4e3.md

latest47.4 KB
Original Source

DevExpress.XtraScheduler Namespace

Contains classes which are used to implement the main functionality of the Scheduler.

Assemblies : DevExpress.XtraScheduler.v25.2.Core.dll, DevExpress.XtraScheduler.v25.2.Core.Desktop.dll

NuGet Packages : DevExpress.Scheduler.Core, DevExpress.Scheduler.CoreDesktop

Classes

NameDescription
AgendaViewAppointmentDisplayOptionsContains options which define how appointments are displayed when the currently active view is the Agenda View.
AppointmentBaseCollectionA collection of appointments.
AppointmentCancelEventArgsServes as the base class for classes which provide data for certain appointment events with the ability to cancel the operation performed.
AppointmentCollectionA collection of appointments.
AppointmentConflictEventArgsProvides data for the SchedulerControl.AllowAppointmentConflicts event.
AppointmentCustomFieldMappingMapping of a custom appointment property to a data field.
AppointmentCustomFieldMappingCollectionRepresents a collection of mappings of the custom properties of appointments to appropriate data fields.
AppointmentDependencyBaseCollectionA collection of appoinment dependencies.
AppointmentDependencyCollectionA collection of appointment dependencies.
AppointmentDependencyCustomFieldMappingSpecifies mapping of a custom property of an appointment dependency to an appropriate data field.
AppointmentDependencyCustomFieldMappingCollectionA collection of mappings of the custom properties of appointments to appropriate data fields.
AppointmentDependencyMappingInfoProvides information on the mapping of the appointment dependency properties to the appropriate data fields.
AppointmentDisplayOptionsServes as the base for classes which provide options to define how appointments are displayed when a particular view is currently active.
AppointmentDisplayTextEventArgsProvides data for the SchedulerControl.InitAppointmentDisplayText event.
AppointmentDragDropOptionsBaseThe base class for options available for drag-and-drop operations with appointments in the scheduler.
AppointmentDragEventArgsProvides data for the SchedulerControl.AppointmentDrag event.
AppointmentDragInfoProvides information on appointments involved in drag-and-drop operations.
AppointmentEventArgsServes as the base class for classes which provide data for certain appointment events.
AppointmentExportedEventArgsProvides data for the AppointmentExporter.AppointmentExported event.
AppointmentExportingEventArgsProvides data for the AppointmentExporter.AppointmentExporting event.
AppointmentImportedEventArgsProvides data for the AppointmentImporter.AppointmentImported event.
AppointmentImportingEventArgsProvides data for the AppointmentImporter.AppointmentImporting event.
AppointmentMappingInfoContains mappings of the appointment properties to the appropriate data fields.
AppointmentOperationEventArgsProvides data for the AllowAppointment events of the SchedulerControl.
AppointmentResizeEventArgsProvides data for the SchedulerControl.AppointmentResizing and SchedulerControl.AppointmentResized events.
AppointmentResourceIdCollectionA collection of resource identifiers.
AppointmentStorageBaseA base class that represents a storage to hold a collection of appointments.
AppointmentSynchronizedEventArgsProvides data for the AppointmentSynchronizer.AppointmentSynchronized event.
AppointmentSynchronizingEventArgsProvides data for the AppointmentSynchronizer.AppointmentSynchronizing event.
CancelListChangedEventArgsProvides data for the SchedulerStorageBase.AppointmentCollectionAutoReloading and SchedulerStorageBase.ResourceCollectionAutoReloading events.
CellsAutoHeightOptionsOptions that configure automatic time cell height.
CustomFieldCollectionA collection of custom fields bound to objects contained in the Scheduler storage.
CustomFieldMappingBase<T>Serves as the base class for classes that provide mapping of the custom properties of persistent objects (appointments or resources) to appropriate data fields.
CustomFieldMappingCollectionBase<T>Serves as the base class for classes that represent collections of custom mappings of the properties of persistent objects (appointments or resources).
CustomizeMessageBoxCaptionEventArgsProvides data for the SchedulerControl.CustomizeMessageBoxCaption event.
DateNavigatorQueryActiveViewTypeEventArgsProvides data for the SchedulerControl.DateNavigatorQueryActiveViewType event.
DayIntervalCollectionContains time intervals of a fixed one day duration.
DayViewAppointmentDisplayOptionsA base class containing options which define how appointments are displayed in the Day View and descendants.
EmptyResourceIdProvides a static method to obtain the identifier of an empty resource.
ExchangeAppointmentEventArgsProvides data for the AppointmentExchanger.GetAppointmentForeignId event.
ExchangeExceptionEventArgsProvides data for the AppointmentExchanger.OnException event.
FetchAppointmentsEventArgsProvides data for the SchedulerStorageBase.FetchAppointments event.
FixedDurationIntervalCollectionA base class for collections which contain time intervals of the fixed duration (day or week).
GanttViewAppointmentDisplayOptionsProvides options which define how appointments are displayed within the Gantt view.
MappingBaseServes as the base class for classes that provide mapping of the properties of persistent objects (appointments or resources) to appropriate data fields.
MappingCollectionRepresents a collection of mappings of the persistent properties of persistent objects (appointments or resources) to appropriate data fields.
MappingInfoBase<T>Serves as the base class for classes which represent mappings of data fields to default persistent object’s properties.
MonthIntervalCollectionContains time intervals of a month duration.
MonthViewAppointmentDisplayOptionsA base class containing options which define how appointments are displayed in the Month View and descendants.
MoreButtonClickedEventArgsProvides data for the SchedulerControl.MoreButtonClicked event.
OccurrenceCalculatorEnables you to calculate the occurrences for a given recurrent appointment.
OptionsSelectionBehaviorProvides options which define how the selection behaves when the time scale is changed for the TimelineView.
OriginalOccurrenceDateHelper staticStatic class used to update data source fields mapped to the Appointment.OriginalOccurrenceStart and Appointment.OriginalOccurrenceEnd properties.
PersistentObjectBase class for appointments, resources and AppointmentDependency objects.
PersistentObjectCancelEventArgsProvides data for the persistent object events of the SchedulerStorage that have a cancel option.
PersistentObjectEventArgsProvides data for the persistent object events of the SchedulerStorage.
PersistentObjectsEventArgsProvides data for the persistent objects events of the SchedulerStorage.
PersistentObjectStorage<T>Represents a base class for the storage of persistent objects (appointments and resources).
QueryResourceColorSchemaEventArgsProvides data for the SchedulerControl.QueryResourceColorSchema event.
QueryWorkTimeEventArgsProvides data for the SchedulerControl.QueryWorkTime event.
RangeControlAdjustEventArgsProvides data for the SchedulerControl.RangeControlAutoAdjusting event.
RecurrenceInfoContains a recurring appointment’s reoccurrence information.
RecurringReminderRepresents a reminder for a recurring appointment.
ReminderRepresents a reminder for a non-recurring appointment.
ReminderAlertNotificationContains information related to the reminder alert.
ReminderAlertNotificationCollectionRepresents a collection of alert notifications.
ReminderBaseServes as the base for classes which represent reminders for non-recurring and recurring appointments.
ReminderBaseAlertNotificationRepresents a reminder alert notification.
ReminderBaseAlertNotificationCollectionRepresents a collection of alert notifications.
ReminderBaseEventArgsServes as the base class for classes which provide data for certain reminder events.
ReminderCancelEventArgsProvides data for the SchedulerStorageBase.FilterReminderAlert event.
ReminderCollectionRepresents a collection of reminders.
ReminderEventArgsProvides data for the SchedulerStorageBase.ReminderAlert event.
RemindersFormDefaultActionEventArgsProvides data for the SchedulerControl.RemindersFormDefaultAction event.
ResourceBaseCollectionA collection of resources for appointments.
ResourceCollectionRepresents a resource collection.
ResourceCustomFieldMappingRepresents a mapping of a custom property of a resource to an appropriate data field.
ResourceCustomFieldMappingCollectionRepresents a collection of mappings of the custom properties of resources to appropriate data fields.
ResourceEmpty staticProvides static methods to obtain the empty resource and its identifier.
ResourceIdCollectionRepresents a collection of resource IDs.
ResourceMappingInfoProvides information on the mapping of the resource’s properties to the data source fields.
ResourceStorageBaseA base class that represents a storage to hold a collection of resources for appointments.
SchedulerColumnPaddingRepresents a storage for the parameters used to specify the distance from the appointmernt’s boundary to the column’s inner border in the Day View
SchedulerCompatibility staticContains static properties used to ensure backward compatibility.
SchedulerControlCompatibility staticContains options which can be specified to ensure compatibility with previous versions.
SchedulerDragDataContains data passed to the target SchedulerControl in the drag-and-drop operation.
SchedulerNavigationButtonOptionsProvides options which define certain characteristics of Navigation Buttons.
SchedulerNotificationOptionsProvides notification options for the Scheduler control.
SchedulerOptionsBehaviorBaseServes as a base class for classes that control certain basic characteristics of the scheduler.
SchedulerOptionsCustomizationProvides customization options for the Scheduler control.
SchedulerOptionsViewBaseDefines a base class for view options for the Scheduler control.
SchedulerResourceHeaderOptionsBaseBase class that provides resource header options for the Scheduler control on different platforms.
SchedulerStorageBaseServes as a base class for a class that represents a storage which holds data for the XtraScheduler control.
SchedulerUnhandledExceptionEventArgsProvides data for the ASPxScheduler.UnhandledException and AppointmentStorageBase.LoadException events.
SelectionBarOptionsProvides options which define how the selection bar in the Timeline View is painted.
TimeIndicatorDisplayOptionsBaseA base class for options which determine how the Time Indicator is displayed in the Scheduler view on different platforms.
TimeIntervalA time interval object.
TimeIntervalCollectionA collection of time intervals.
TimeIntervalCollectionExRepresents an advanced collection of time intervals.
TimeIntervalEventArgsProvides data for the SchedulerStorageBase.FetchAppointments event.
TimelineViewAppointmentDisplayOptionsProvides options which define how appointments are displayed when the currently active view is the Timeline View.
TimeOfDayIntervalA time interval within a day.
TimeOfDayIntervalCollectionRepresents a collection of time intervals for a single day.
TimeRulerA time ruler.
TimeRulerCollectionRepresents a collection of time rulers.
TimeScaleServes as the base class for classes which are time scales in the Timeline view.
TimeScale15MinutesA time scale whose time cell value is equal to 15 minutes.
TimeScaleCollectionRepresents a collection of time scales in the timeline view.
TimeScaleDayRepresents a time scale whose time cell value is equal to a single day.
TimeScaleFixedIntervalServes as a base for the classes for which TimeScaleFixedInterval.Value is a fixed time interval.
TimeScaleHourRepresents a time scale whose time cell value is equal to a single hour.
TimeScaleMonthRepresents a time scale whose time cell value is equal to a single month.
TimeScaleQuarterRepresents a time scale whose time cell value is equal to a quarter of a year.
TimeScaleWeekRepresents a time scale whose time cell value is equal to a single week.
TimeScaleYearRepresents a time scale whose time cell value is equal to a single year.
TimeSlotAn individual time slot item.
TimeSlotCollectionA collection of time slots.
TimeZoneHelperA class implemented for time zone conversion.
UserInterfaceObjectRepresents a base class for certain user interface objects.
UserInterfaceObjectCollection<T>Represents a base collection for user interface objects.
VisibleResourcesChangedEventArgsProvides data for the SchedulerControl.VisibleResourcesChanged event.
WeekDaysWorkDayRepresents a class that defines which days of the week are the work days.
WeekIntervalCollectionA collection that contains time intervals of a fixed one week duration.
WeekViewAppointmentDisplayOptionsA base class containing options which define how appointments are displayed in the Week View and its descendants.
WorkDaysCollectionRepresents a collection of dates, for which the information regarding a working activity is known.
WorkTimeIntervalA time interval that can be used instead of the TimeOfDayInterval class to specify the work time within a day.

Interfaces

NameDescription
AppointmentAn interface that defines an appointment in the Scheduler.
AppointmentDependencyA dependency established between tasks ( Appointment objects) in the Gantt view.
IAppointmentDependencyFactoryProvides methods for creating appointment dependencies.
IAppointmentDependencyStorageAn interface of a storage which holds a collection of appointment dependencies.
IAppointmentFactoryProvides methods for creating appointments.
IAppointmentLabelPlatform-independent interface that defines the appointment label.
IAppointmentLabelStorageAn interface that defines a storage which holds appointment labels.
IAppointmentStatusPlatform-independent interface that defines appointment statuses.
IAppointmentStatusStorageAn interface that defines a storage which holds appointment statuses.
IAppointmentStorageBaseA platform-independent base interface that defines a storage which holds appointments.
IIdProviderAn interface that defines a method to supply an object identifier. Implemented in Scheduler objects which have identifiers (almost all persistent and user interface objects).
IPersistentObjectA base interface for the Scheduler persistent objects (appointments, resources, appointment dependencies).
IPersistentObjectStorage<T>Base interface that defines a storage which holds persistent objects.
IRecurrenceInfoA base interface that defines recurrence information.
IResourceFactoryProvides methods for creating resources.
IResourceStorageBaseA base interface that defines a storage which holds resources for appointments.
ISchedulerColorSchemaCollection<T>A base interface which defines a generic collection of color schemas.
ISchedulerInplaceEditorExThe interface is designed for implementing a custom in-place editor.
ISchedulerMappingConverterEnables you to apply custom logic to a mapping.
ISchedulerStorageBaseA base platform-independent interface that defines a storage which holds the Scheduler data.
ResourceDefines a common attribute which can be assigned to appointments to group them.

Delegates

NameDescription
AppointmentConflictEventHandlerRepresents a method that will handle the SchedulerControl.AllowAppointmentConflicts event.
AppointmentDisplayTextEventHandlerRepresents a method that will handle the SchedulerControl.InitAppointmentDisplayText event.
AppointmentDragEventHandlerRepresents a method that will handle the SchedulerControl.AppointmentDrag event.
AppointmentEventHandlerRepresents a method that will handle the SchedulerControl.InitNewAppointment event.
AppointmentExportedEventHandlerRepresents a method that will handle the AppointmentExporter.AppointmentExported event.
AppointmentExportingEventHandlerRepresents a method that will handle the AppointmentExporter.AppointmentExporting event.
AppointmentImportedEventHandlerRepresents a method that will handle the AppointmentImporter.AppointmentImported event.
AppointmentImportingEventHandlerRepresents a method that will handle the AppointmentImporter.AppointmentImporting event.
AppointmentOperationEventHandlerRepresents a method that will handle the AllowAppointment events of the SchedulerControl.
AppointmentResizeEventHandlerRepresents a method that will handle events associated with appointment resizing.
AppointmentSynchronizedEventHandlerRepresents a method that will handle the AppointmentSynchronizer.AppointmentSynchronized event.
AppointmentSynchronizingEventHandlerRepresents a method that will handle the AppointmentSynchronizer.AppointmentSynchronizing event.
CancelListChangedEventHandlerRepresents a method that will handle the SchedulerStorageBase.AppointmentCollectionAutoReloading and SchedulerStorageBase.ResourceCollectionAutoReloading events.
CustomizeMessageBoxCaptionEventHandlerA method that will handle the SchedulerControl.CustomizeMessageBoxCaption event.
DateNavigatorQueryActiveViewTypeHandlerA method that will handle SchedulerControl.DateNavigatorQueryActiveViewType and ASPxScheduler.DateNavigatorQueryActiveViewType events.
ExchangeAppointmentEventHandlerRepresents a method that will handle the AppointmentExchanger.GetAppointmentForeignId event.
ExchangeExceptionEventHandlerRepresents a method that will handle the events associated with the AppointmentExchanger.OnException event.
FetchAppointmentsEventHandlerRepresents a method that will handle the SchedulerStorageBase.FetchAppointments event.
MoreButtonClickedEventHandlerRepresents a method that will handle the SchedulerControl.MoreButtonClicked event.
PersistentObjectCancelEventHandlerRepresents a method that will handle the persistent object events of the SchedulerStorage that have a cancel option.
PersistentObjectEventHandlerRepresents a method that will handle the persistent object events of the SchedulerStorage.
PersistentObjectsEventHandlerRepresents a method that will handle the persistent objects events of the SchedulerStorage.
QueryResourceColorSchemaEventHandlerRepresents a method that will handle the SchedulerControl.QueryResourceColorSchema event.
QueryWorkTimeEventHandlerRepresents a method that will handle the SchedulerControl.QueryWorkTime event.
RangeControlAdjustEventHandlerA method that will handle the SchedulerControl.RangeControlAutoAdjusting event.
ReminderEventHandlerRepresents a method that will handle the SchedulerStorageBase.ReminderAlert event.
RemindersFormDefaultActionEventHandlerRepresents a method that will handle the SchedulerControl.RemindersFormDefaultAction event.
SchedulerUnhandledExceptionEventHandlerRepresents a method that will handle the ASPxScheduler.UnhandledException event.
TimeIntervalEventHandlerRepresents a method that will handle the SchedulerStorageBase.FetchAppointments event.
VisibleResourcesChangedEventHandlerA method that will handle the SchedulerControl.VisibleResourcesChanged event.

Enums

NameDescription
AllowDisplayAppointmentDependencyFormLists the values used to specify whether the Appointment Dependency dialog can be displayed or not.
AllowDisplayAppointmentFormLists the values used to specify whether the Edit Appointment form can be displayed or not.
AppointmentConflictsModeLists the modes which specify if appointments conflicts are allowed.
AppointmentContinueArrowDisplayTypeLists the values used to specify the type of sign to indicate that the scheduled time continues beyond the visible interval of dates.
AppointmentDependencySelectionChangeActionSpecifies how the selection is applied to the specified appointment dependency.
AppointmentDependencyTypeSpecifies when a task should start and end in relation to another task.
AppointmentSelectionChangeActionSpecifies how the selection is applied to the specified appointment.
AppointmentSnapToCellsModeLists the modes of appointment fit in the time cell(s) by stretching it to the cell’s limits.
AppointmentStatusDisplayTypeLists the values used to specify how the appointment status is displayed within an appointment.
AppointmentStatusTypeLists the appointment status types.
AppointmentTimeDisplayTypeLists the values used to specify how the start and end time are displayed within appointments.
AppointmentTimeVisibilityLists the values used to specify the visibility state of the start and end time within appointments.
AppointmentTypeLists the types of appointment.
ColorSavingTypeLists the allowed color representation formats.
DateTimeSavingModeLists modes which affect how the Start and End appointment values are stored in the data source.
DstBehaviorTypeLists the types of behavior that can be set to the reminder if it falls in the Daylight Saving Time shift - a non-existing time interval on the Daylight Saving Time start date, usually between 2:00:00 and 2:59:59 AM.
FieldValueTypeContains values that specify the data type of the mapped data column in the unbound mode.
FirstDayOfWeekLists the days which can be used to specify the first day of the week.
HeaderImageAlignSpecifies how an image is positioned relative to the text within a resource header.
HeaderImageSizeModeSpecifies how an image is positioned within a resource header.
MappingConversionBehaviorLists converter locations in the data processing chain.
MouseWheelScrollActionLists scrolling interpretations for the bidirectional mouse wheel.
NavigationButtonVisibilityLists the modes that define the conditions for the Navigation Buttons being displayed.
PercentCompleteDisplayTypeSpecifies how the percentage of completion is displayed for appointments (tasks) within the Gantt view.
QueryDeleteAppointmentResultObsolete. Lists the keys specifying which appointment occurrences should be deleted.
RangeControlDataDisplayTypeLists the values used to specify how appointment data should be displayed within a RangeControl when it is bound to a SchedulerControl.
RecurrenceRangeLists the types of recurrence range.
RecurrenceTypeLists the types of recurrent appointments.
RecurrentAppointmentActionLists actions which could be performed on a recurrent appointment.
RemindersFormDefaultActionLists the types of default actions which can be applied after the Reminders form is closed.
ResizedSideLists appointment boundaries which could be moved when the appointment is being resized.
ResourceNavigatorVisibilityLists the visibility modes of the resource navigator.
SchedulerGroupTypeLists the grouping type used in the scheduler.
SchedulerMenuItemIdLists items that can be used in the context menus of a Scheduler.
SchedulerScrollBarVisibilityLists modes that determine the vertical scrollbar visibility in the Timeline view and in all-day area of the Day view.
SchedulerViewTypeLists the view types for a scheduler.
SynchronizeOperationLists the values used to specify the currently performed operation when synchronizing the scheduler’s data.
TimeIndicatorVisibilityLists modes used to display the Time Indicator visual element in the Scheduler view.
TimeMarkerVisibilityLists modes which determine how the time marker on the TimeRuler is displayed.
TimeRulerHorizontalAlignmentSpecifies the alignment of the Time ruler relative to the scheduler view.
ToolTipVisibilityLists the visibility mode of the scheduler’s tooltips.
UpdateSelectionDurationActionSpecifies how the selection extends when the time scale is changed to a larger one.
UsedAppointmentTypeLists values which specify restrictions for end-users on which appointments can be used in particular events.
WeekDaysLists days and groups of days for recurrence patterns.
WeekOfMonthLists the week in a month in which the event will occur.