Back to Devexpress

DevExpress.XtraScheduler Namespace

windowsforms-devexpress-7a177809.md

latest28.7 KB
Original Source

DevExpress.XtraScheduler Namespace

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

Assembly : DevExpress.XtraScheduler.v25.2.dll

NuGet Package : DevExpress.Win.Scheduler

Classes

NameDescription
ActiveViewChangingEventArgsProvides data for the SchedulerControl.ActiveViewChanging event.
AgendaViewA view that lists appointments by day.
AgendaViewAppearanceProvides appearance settings used to paint the Agenda view.
AppointmentDataStorageA storage that holds a collection of appointments.
AppointmentDependencyDataStorageA storage which holds a collection of appointment dependencies.
AppointmentDependencyFormEventArgsProvides data for the SchedulerControl.EditAppointmentDependencyFormShowing event.
AppointmentDependencyStorageA storage which holds a collection of appointment dependencies.
AppointmentDragDropOptionsContains options specific for appointment drag-and-drop operations.
AppointmentFlyoutHtmlElementMouseEventArgsContains data for the AppointmentFlyoutHtmlElementMouseClick event.
AppointmentFlyoutOptionsContains options which define how appointment flyouts are displayed.
AppointmentFlyoutShowingEventArgsProvides data for the SchedulerControl.AppointmentFlyoutShowing event.
AppointmentFormEventArgsProvides data for the SchedulerControl.EditAppointmentFormShowing event.
AppointmentImagesEventArgsProvides data for the SchedulerControl.InitAppointmentImages event.
AppointmentLabelRepresents an appointment’s identification label.
AppointmentLabelCollectionA collection of appointment labels.
AppointmentLabelDataStorageA collection of Scheduler Labels that specify appointments’ background colors.
AppointmentLabelExtension staticDefines extension methods for the AppointmentLabel interface.
AppointmentStatusAppointment’s availability status.
AppointmentStatusCollectionRepresents a collection of appointment statuses.
AppointmentStatusDataStorageA collection of Scheduler Statuses that specify appointments’ side color stripes.
AppointmentStatusExtension staticDefines extension methods for the AppointmentStatus interface.
AppointmentStorageRepresents a storage which holds a collection of appointments.
AppointmentViewInfoCustomizingEventArgsProvides data for the SchedulerControl.AppointmentViewInfoCustomizing event.
BaseHeaderAppearanceServes as the base class for classes that provide the appearance settings for the scheduler’s elements.
BaseViewAppearanceServes as the base class for classes that provide the appearance settings used to paint view elements.
CustomAppointmentFlyoutTemplateValueEventArgsContains data for the CustomAppointmentFlyoutTemplateValue event.
CustomDrawAppointmentFlyoutSubjectEventArgsProvides data for the SchedulerControl.CustomDrawAppointmentFlyoutSubject event.
CustomDrawObjectEventArgsProvides data for the custom draw events of the SchedulerControl.
CustomizeAppointmentFlyoutEventArgsProvides data for the SchedulerControl.CustomizeAppointmentFlyout event.
CustomizeAppointmentFlyoutTemplateEventArgsContains data for the CustomizeAppointmentFlyoutTemplate event.
CustomizeDateNavigationBarCaptionEventArgsProvides data for the SchedulerControl.CustomizeDateNavigationBarCaption event.
DateNavigatorThe calendar control for navigating dates. Can be associated with a SchedulerControl to retrieve various information (e.g., appointment dates).
DayViewDisplays a detailed picture of events across one or more days.
DayViewAppearanceProvides the appearance settings used to paint a Day View.
DayViewAppointmentDisplayOptionsExExtends the DayViewAppointmentDisplayOptions class to provide WinForms-specific options.
DeleteRecurrentAppointmentFormEventArgsProvides data for the SchedulerControl.DeleteRecurrentAppointmentFormShowing event.
EditRecurrentAppointmentFormEventArgsProvides data for the SchedulerControl.EditRecurrentAppointmentFormShowing event.
FullWeekViewRepresents a view that displays the entire week.
GanttViewA view that shows tasks, the relationship among the tasks and task progress in relation to time.
GanttViewAppearanceProvides appearance settings used to paint the Gantt view.
GotoDateFormEventArgsProvides data for the SchedulerControl.GotoDateFormShowing event.
InplaceEditorEventArgsProvides data for the SchedulerControl.InplaceEditorShowing event.
LabelMappingInfoProvides access to Label Mappings.
LayoutViewInfoCustomizingEventArgsProvides data for the SchedulerControl.LayoutViewInfoCustomizing event.
MonthViewDisplays events across multiple weeks.
MonthViewAppearanceProvides the appearance settings used to paint a Month View.
MonthViewAppointmentDisplayOptionsExExtends the MonthViewAppointmentDisplayOptions class to provide WinForms-specific options.
PopupMenuShowingEventArgsProvides data for the SchedulerControl.PopupMenuShowing event.
PrepareContextMenuEventArgsObsolete. Provides data for the SchedulerControl.PrepareContextMenu event.
PrepareFilterColumnEventArgsProvides data for the SchedulerStorage.PrepareAppointmentFilterColumn and SchedulerStorage.PrepareResourceFilterColumn events.
PreparePopupMenuEventArgsObsolete. Provides data for the SchedulerControl.PreparePopupMenu event.
RecurrentAppointmentActionFormEventArgsProvides data for the SchedulerControl.DeleteRecurrentAppointmentFormShowing event.
RemindersFormActionEventArgsContains data for the RemindersFormAction event.
RemindersFormEventArgsProvides data for the SchedulerControl.RemindersFormShowing event.
ResourceCategoryRepresents a resource category.
ResourceCategoryOptionsProvides access to options that specify resource categories.
ResourceDataStorageA storage that holds appointment resources.
ResourceExtension staticDefines extension methods for the Resource object.
ResourceNavigatorRepresents the Resource Navigator control.
ResourceStorageRepresents a storage which holds appointment resources.
ScaleBasedRangeControlClientOptionsA base class for options that specify the interaction settings for a RangeControl and SchedulerControl that are integrated.
SchedulerAppearanceProvides the appearance settings used to paint a scheduler control.
SchedulerColorSchemaA color schema which contains colors for a scheduler’s resources.
SchedulerColorSchemaCollectionA collection of color schemas.
SchedulerControlDisplays scheduled data using one of the available views and provides the capability to edit, save and load appointments. See Scheduler.
SchedulerDataStorageThe component that holds data for the SchedulerControl.
SchedulerDateNavigationBarA Date Navigation Bar control.
SchedulerDeferredScrollingOptionProvides access to an object that specifies how deferred scrolling is performed.
SchedulerHtmlTemplateItemAn HTML-CSS template used to render Scheduler visual elements.
SchedulerInplaceEditorEventArgsProvides parameters which can be used to instantiate a custom in-place editor within the SchedulerControl.InplaceEditorShowing event handler.
SchedulerMenuCheckItemRepresents an individual check item that is displayed within a Scheduler ‘s popup (context) menu.
SchedulerMenuItemRepresents an individual item that is displayed within a Scheduler ‘s popup (context) menu.
SchedulerOptionsBehaviorProvides behavior options for the Scheduler control.
SchedulerOptionsPrintProvides print options for the Scheduler control.
SchedulerOptionsRangeControlProvides interaction options for a RangeControl and SchedulerControl that are integrated.
SchedulerOptionsViewProvides view options for the Scheduler control.
SchedulerPopupMenuRepresents a popup (context) menu of the Scheduler.
SchedulerResourceHeaderOptionsProvides resource header options for the Scheduler control.
SchedulerStorageUse a SchedulerDataStorage as a component that holds data for the SchedulerControl.
SchedulerViewBaseA base class for the scheduler views.
SchedulerViewRepositoryRepresents the view repository.
ShowFormEventArgsProvides data for the events which show dialogs in the XtraScheduler.
StatusMappingInfoProvides access to Status mappings.
TimeIndicatorDisplayOptionsContains options which determine how the Time Indicator is displayed in the Scheduler view.
TimelineViewArranges events and appointments across horizontal timelines.
TimelineViewAppearanceProvides the appearance settings used to paint a Timeline View.
TimelineViewAppointmentDisplayOptionsExExtends the TimelineViewAppointmentDisplayOptions class to provide WinForms-specific options.
TimeRegionAn area with unique user restrictions. Limits the appointments that can be placed inside this time interval and/or users that can add these appointments.
TimeScaleWorkDayA time scale whose time cell is equal to a single day. Does not include weekends and holidays.
TimeScaleWorkHourA time scale whose time cell is equal to a single day. Does not include non-working hours of a day.
WeekView

Displays events across a week in a compact form.

This view is outdated and provided for compatibility with the earlier versions of the Scheduler Control. Use the FullWeekView instead.

| | WeekViewAppearance | Provides the appearance settings used to paint a Week View. | | WeekViewAppointmentDisplayOptionsEx | Extends the WeekViewAppointmentDisplayOptions class to provide WinForms-specific options. | | WorkWeekView | Displays appointments for the working days in a particular week. | | WorkWeekViewAppearance | Provides the appearance settings used to paint a Work Week View. | | YearView | Displays appointments for the entire year. | | YearViewAppointmentDisplayOptionsEx | Contains options that specify how appointments are displayed in the Year View. |

Interfaces

NameDescription
IAppointmentFlyoutDataContains data used in the Appointment Flyout.
IAppointmentStorageDefines the base interface for different types of the Scheduler storage - the legacy appointment storage and a new asynchronous storage.
ISchedulerInplaceEditorProvides methods to customize properties of an in-place editor.
ISchedulerStorageA storage containing persistent objects - appointments, resources and appointment dependencies.

Delegates

NameDescription
ActiveViewChangingEventHandlerA method that handles the SchedulerControl.ActiveViewChanging event.
AppointmentDependencyFormEventHandlerA method that handles the SchedulerControl.EditAppointmentDependencyFormShowing event.
AppointmentFlyoutShowingEventHandlerA method that handles the SchedulerControl.AppointmentFlyoutShowing event.
AppointmentFormEventHandlerA method that handles the SchedulerControl.EditAppointmentFormShowing event.
AppointmentImagesEventHandlerA method that handles the SchedulerControl.InitAppointmentImages event.
AppointmentViewInfoCustomizingEventHandlerA method that handles the SchedulerControl.AppointmentViewInfoCustomizing event.
CustomDrawAppointmentFlyoutSubjectEventHandlerA method that handles the SchedulerControl.CustomDrawAppointmentFlyoutSubject event.
CustomDrawObjectEventHandlerA method that handles the custom draw events of the SchedulerControl.
CustomizeAppointmentFlyoutEventHandlerA method that handles the SchedulerControl.CustomizeAppointmentFlyout event.
DeleteRecurrentAppointmentFormEventHandlerA method that handles the SchedulerControl.DeleteRecurrentAppointmentFormShowing event.
EditRecurrentAppointmentFormEventHandlerA method that handles the SchedulerControl.EditRecurrentAppointmentFormShowing event.
GotoDateFormEventHandlerA method that handles the SchedulerControl.GotoDateFormShowing event.
InplaceEditorEventHandlerA method that handles the SchedulerControl.InplaceEditorShowing event.
PopupMenuShowingEventHandlerA method that handles the SchedulerControl.PopupMenuShowing event.
PrepareContextMenuEventHandlerObsolete. A method that handles the SchedulerControl.PrepareContextMenu event.
PrepareFilterColumnEventHandlerA method that handles the PrepareFilterColumnEventArgs.FilterColumn event.
PreparePopupMenuEventHandlerObsolete. A method that handles the SchedulerControl.PreparePopupMenuevent.
RemindersFormEventHandlerA method that handles the SchedulerControl.RemindersFormShowing event.

Enums

NameDescription
AppointmentDisplayModeEnumerates values that specify whether to display appointments that belong to all resources in a category or to the selected resource only.
BrushSavingTypeProvides values that specify the type of values stored in the data source field mapped to the StatusMappingInfo.Brush property.
DateNavigationModeDefines the behavior mode of the DateNavigator selection when navigating months.
DragDropModeLists the values used to specify the drag-and-drop mode of the scheduler control.
DXColorSavingTypeProvides values that specify the type of values stored in the data source field mapped to the LabelMappingInfo.Color property.
LayoutElementKindLists types of visual elements in a scheduler control that triggered the event.
RemindersFormActionTypeLists actions of the Reminders Form.
ResourceDisplayStyleEnumerates values that specify how to display resources in categories: as resource tabs or category headers.
SchedulerColorIdLists legacy label colors.
SchedulerViewStatusDisplayTypeLists how the appointment status can be displayed in the view.