Back to Devexpress

DevExpress.Web.ASPxScheduler Namespace

aspnet-devexpress-dot-web-c9901f31.md

latest39.5 KB
Original Source

DevExpress.Web.ASPxScheduler Namespace

Contains classes which implement the main functionality of the ASPxScheduler control.

Assembly : DevExpress.Web.ASPxScheduler.v25.2.dll

NuGet Package : DevExpress.Web.Scheduler

Classes

NameDescription
ActiveViewChangingEventArgsProvides data for the ASPxScheduler.ActiveViewChanging event.
AgendaAppointmentCellStyleContains settings that allow you to define the appearance of layout cells displayed within the Agenda View‘s appointments.
AgendaAppointmentStylesContains settings that allow you to define the appearance of appointments displayed by the Agenda View.
AgendaCellStyleContains settings that allow you to define the appearance of layout cells displayed within the Agenda View.
AgendaCellStyleBaseServes as a base for classes that define the appearance styles of Agenda View‘s layout cells.
AgendaDateCellStyleContains settings that allow you to define the appearance of layout cells displayed within the Agenda View‘s date header.
AgendaEmptyCellStyleContains settings that allow you to define the appearance of empty layout cells displayed within the Agenda View.
AgendaHorizontalDateHeaderStylesContains settings that allow you to define the appearance of the Agenda View’s date headers.
AgendaStylesBaseProvides base settings defining the appearance of different Agenda View visual elements.
AgendaTodayHorizontalDateHeaderStylesContains settings that allow you to define the appearance of the Agenda View’s today date header that is horizontally oriented.
AgendaTodayVerticalDateHeaderStylesContains settings that allow you to define the appearance of the Agenda View’s today date header that is vertically oriented.
AgendaVerticalDateHeaderStylesContains settings that allow you to define the appearance of the Agenda View’s date headers.
AgendaViewRepresents an Agenda View.
AgendaViewStylesContains settings that allow you to define the appearance of the Agenda View‘s visual elements.
AgendaViewTemplatesContains the templates used to display the Agenda View elements.
AppointmentDialogLayoutSettingsContains settings that relate to an appointment dialog layout.
AppointmentFormBaseEventArgsServes as a base class for the objects, providing data for events occurring before displaying the appointment form.
AppointmentFormEventArgsProvides data for the ASPxScheduler.AppointmentFormShowing event.
AppointmentFormTemplateContainerRepresents a container for the templates used to render the Edit Appointment form.
AppointmentFormTemplateContainerBaseRepresents a base class for different Appointment Form template container objects.
AppointmentImagesHolds images used to display within the appointments.
AppointmentImagesEventArgsProvides data for the ASPxScheduler.InitAppointmentImages event.
AppointmentInplaceEditorEventArgsProvides data for the ASPxScheduler.AppointmentInplaceEditorShowing event.
AppointmentInplaceEditorTemplateContainerRepresents a container for the templates used to render the Inplace Editor form.
AppointmentLabelRepresents an appointment’s identification label.
AppointmentLabelCollectionRepresents a collection of appointment labels.
AppointmentStatusRepresents an appointment’s availability status.
AppointmentStatusCollectionRepresents a collection of appointment statuses.
AppointmentTemplateContainerRepresents a container for the templates used to render the appointment’s visual representation.
AppointmentViewInfoCustomizingEventArgsProvides data for the ASPxScheduler.AppointmentViewInfoCustomizing event.
ASPxAgendaViewAppointmentDisplayOptionsContains settings specific to displaying appointments in the Agenda View.
ASPxAppointmentCustomFieldMappingRepresents a mapping of a custom property of an appointment to an appropriate data field.
ASPxAppointmentCustomFieldMappingCollectionRepresents a collection of mappings of the custom properties of appointments to appropriate data fields.
ASPxAppointmentMappingInfoProvides information on the mapping of the appointment’s properties to the appropriate data fields.
ASPxAppointmentStorageRepresents a storage which holds a collection of appointments.
ASPxDateNavigatorRepresents a Date Navigator.
ASPxDayViewAppointmentDisplayOptionsContains settings specific to displaying appointments in the Day View and its descendants.
ASPxMonthViewAppointmentDisplayOptionsContains settings specific to displaying appointments in the Month View.
ASPxResourceCustomFieldMappingRepresents a mapping of a custom property of a resource to an appropriate data field.
ASPxResourceCustomFieldMappingCollectionRepresents a collection of mappings of the custom properties of resources to appropriate data fields.
ASPxResourceMappingInfoProvides information on the mapping of the resource’s properties to appropriate data fields.
ASPxResourceNavigatorRepresents the Resource Navigator control.
ASPxResourceStorageRepresents a storage which holds appointment resources.
ASPxSchedulerA scheduler control.
ASPxSchedulerCustomErrorTextEventArgsProvides data for the ASPxScheduler.CustomErrorText event.
ASPxSchedulerDataBaseUpdatedEventArgsRepresents the base class for the handlers of the events which are raised on data operation with the appointment’s data source.
ASPxSchedulerDataDeletedEventArgsProvides data for the ASPxSchedulerDataWebControlBase.AppointmentRowDeleted event.
ASPxSchedulerDataDeletingEventArgsProvides data for the ASPxSchedulerDataWebControlBase.AppointmentRowDeleting event.
ASPxSchedulerDataInsertedEventArgsProvides data for the ASPxSchedulerDataWebControlBase.AppointmentRowInserted event.
ASPxSchedulerDataInsertingEventArgsProvides data for the ASPxSchedulerDataWebControlBase.AppointmentRowInserting event.
ASPxSchedulerDataUpdatedEventArgsProvides data for the ASPxSchedulerDataWebControlBase.AppointmentRowUpdated event.
ASPxSchedulerDataUpdatingEventArgsProvides data for the ASPxSchedulerDataWebControlBase.AppointmentRowUpdating event.
ASPxSchedulerDataWebControlBaseServes as a base class for the scheduler-based controls.
ASPxSchedulerDialogLayoutSettingsContains settings that relate to a control’s dialog layout.
ASPxSchedulerFormDataHelper staticProvides methods used to create data sources for appointments.
ASPxSchedulerImagesContains settings that allow images to be defined for the scheduler’s specific elements.
ASPxSchedulerOptionsAdaptivityContains settings that relate to the scheduler’s adaptivity.
ASPxSchedulerOptionsBehaviorHolds options, specifying certain basic characteristics of the scheduler.
ASPxSchedulerOptionsCellAutoHeightHolds options used to set an auto height cell behavior.
ASPxSchedulerOptionsCookiesHolds parameters used to save a control’s state in cookies.
ASPxSchedulerOptionsFormsContains settings that specify the templates location for displaying the end-user dialog forms (appointment editing, reminder processing and date navigation).
ASPxSchedulerOptionsLoadingPanelRepresents a window that is briefly displayed when an ASPxScheduler control reloads itself on a page.
ASPxSchedulerOptionsMenuProvides options for displaying the popup menu.
ASPxSchedulerOptionsToolTipsProvides access to options characterizing appointment and selection tooltips.
ASPxSchedulerOptionsViewProvides view options for the ASPxScheduler control.
ASPxSchedulerPopupFormRepresents a form based on a web control with popup window functionality.
ASPxSchedulerPopupMenuRepresents a popup menu of the ASPxScheduler.
ASPxSchedulerPrepareFormPopupContainerEventArgsProvides data for the ASPxScheduler.PrepareAppointmentFormPopupContainer, the ASPxScheduler.PrepareAppointmentInplaceEditorPopupContainer, the ASPxScheduler.PrepareGotoDateFormPopupContainer, the ASPxScheduler.PrepareRecurrenceAppointmentDeleteFormPopupContainer, the ASPxScheduler.PrepareRecurrenceAppointmentEditFormPopupContainer, and the ASPxScheduler.PrepareRemindersFormPopupContainer events.
ASPxSchedulerRelatedControlServes as a base class for controls, accompanying the ASPxScheduler control in a suite.
ASPxSchedulerRelatedControlBaseServes as a base class for controls, accompanying the ASPxScheduler control in a suite.
ASPxSchedulerResourceHeaderOptionsContains appearance settings specific to Resource Headers.
ASPxSchedulerStorageRepresents a storage which holds data for the ASPxScheduler control.
ASPxSchedulerStorageControlRepresents a non-visual component that implements all scheduler-based data operations using third-party web controls.
ASPxSchedulerStylesContains the scheduler element’s style settings.
ASPxSchedulerTimeCellPreparedEventArgsProvides data for the ASPxScheduler.HtmlTimeCellPrepared event.
ASPxTimelineViewAppointmentDisplayOptionsContains settings specific to displaying appointments in the Timeline View.
ASPxTimeZoneEditA combo box editor used to specify a time zone.
ASPxViewNavigatorRepresents the View Navigator control.
ASPxViewSelectorRepresents the View Selector control of the ASPxScheduler suite.
ASPxViewSelectorOptionsAdaptivityContains settings that relate to adaptivity settings of the scheduler’s view selector.
ASPxViewVisibleIntervalRepresents the View Visible Interval control.
ASPxViewVisibleIntervalOptionsAdaptivityContains settings that relate to adaptivity settings of the scheduler’s view visible interval.
ASPxWeekViewAppointmentDisplayOptionsContains settings specific to displaying appointments in the Week View.
BottomLeftCornerStyleContains settings that allow you to define the appearance of the bottom left corner of the Scheduler.
CellBodyStyleContains settings that allow you to define the appearance of the cells in the Scheduler’s Timeline view.
ClientSideAppointmentFieldNames staticLists appointment property names for a client-side appointment.
ClockImagesContains settings that allow images to be defined for different clock states.
CustomizeElementStyleEventArgsProvides data for the ASPxScheduler.CustomizeElementStyle event.
DateCellHeaderTemplateContainer
DateNavigatorClientSideEventsContains a client-side date navigator’s event list.
DateNavigatorPropertiesRepresents settings specific to the calendar functionality of the ASPxDateNavigator control.
DayViewRepresents a Day View.
DayViewStylesContains settings that allow you to define the appearance of the Day view’s visual elements.
DayViewTemplatesContains the templates used to display the Day view elements.
FABCreateAppointmentActionRepresents the floating action button’s action that allows you to create a new appointment.
FABCreateAppointmentActionGroupRepresents the floating action button’s action group that contains action items related to appointment creation.
FABCreateAppointmentActionItemRepresents the action item that is located within the action group related to appointment creation.
FABCreateRecurringAppointmentActionItemRepresents the action item that allows you to create a recurring appointment.
FABDeleteAppointmentActionItemRepresents the action item that allows you to delete an appointment.
FABEditAppointmentActionGroupRepresents the floating action button’s action group that contains action items related to appointment editing.
FABEditAppointmentActionItemRepresents the action item that allows you to edit an appointment.
FullWeekViewA class for the Full Week View.
FullWeekViewStylesContains settings that allow you to define the appearance of the Full Week view’s visual elements.
GotoDateDialogLayoutSettingsProvides access to the “Go To Date” dialog’s layout settings.
GotoDateFormEventArgsProvides data for the ASPxScheduler.GotoDateFormShowing event.
GotoDateFormTemplateContainerRepresents a container for the templates used to render the GotoDate form.
HeaderStyleContains settings that allow you to define the header appearance.
InitClientAppointmentEventArgsProvides data for the ASPxScheduler.InitClientAppointment event.
MonthViewRepresents a Month (Multi-Week) View.
MonthViewStylesContains settings that allow you to define the appearance of the Month view’s visual elements.
MonthViewTemplates
PopupMenuShowingEventArgsProvides data for the ASPxScheduler.PopupMenuShowing event.
PreparePopupMenuEventArgsObsolete. Provides data for the PreparePopupMenu event.
RecurrenceDialogLayoutSettingsProvides layout settings of the recurrent appointment dialog.
RecurrentAppointmentDeleteDialogLayoutSettingsProvides layout settings of the recurrent appointment “Delete” dialog.
RecurrentAppointmentEditDialogLayoutSettingsProvides layout settings of the recurrent appointment “Edit” dialog.
ReminderDialogLayoutSettingsProvides access to the reminder dialog’s layout settings.
ResourceNavigatorRepresents the Resource Navigator control.
ResourceNavigatorPagerPropertiesContains settings specific to the Pager ‘ Resource Navigator navigation mode.
ResourceNavigatorPropertiesServes as a base class for classes that contain settings specific to the Resource Navigator navigation modes.
ResourceNavigatorPropertiesBaseA base class for classes that contain settings for the resource navigator control.
ResourceNavigatorTokensPropertiesContains settings specific to the Tokens ‘ Resource Navigator navigation mode.
SchedulerCallbackCommandEventArgsProvides data for the ASPxScheduler.BeforeExecuteCallbackCommand and ASPxScheduler.AfterExecuteCallbackCommand events.
SchedulerCallbackCommandId staticLists command identifiers for correct command interpretation on the server.
SchedulerClientSideEventsContains a list of client-side events concerned with processing callbacks within the scheduler control.
SchedulerCustomShortcutCollectionRepresents a collection of custom keyboard shortcuts.
SchedulerFABActionItemServes as a base class for classes that represent the floating action button’s actions and action groups related to the ASPxScheduler.
SchedulerFormEditorsImagesContains settings that allow images to be defined for specific elements of editors used within the ASPxScheduler.
SchedulerFormEventArgsProvides data for the ASPxScheduler.AppointmentFormShowing and ASPxScheduler.GotoDateFormShowing events
SchedulerFormTemplateContainerThe base class for all form templates used by ASPxScheduler.
SchedulerShortcutRepresents a keyboard shortcut.
SchedulerShortcutCommands staticContains a set of the available shortcut commands.
SchedulerStorageClientSideEventsContains a client-side scheduler storage’s event list.
SchedulerTemplatesContains the templates used to display the ASPxScheduler’s elements.
SchedulerViewBaseServes as a base class for different scheduler Views.
SchedulerViewRepositoryRepresents the storage area for Scheduler’s Views.
SelectionBarStyleContains settings that allow you to define the appearance of the selection bar in the Scheduler.
TimeIndicatorDisplayOptionsContains options which determine how the Time Indicator is displayed in the Scheduler view.
TimelineViewRepresents a Timeline View.
TimelineViewStylesContains settings that allow you to define the appearance of the Timeline View‘s visual elements.
ViewNavigatorPropertiesRepresents settings specific to the calendar functionality of the ASPxViewNavigator control.
WeekViewRepresents a Week View.
WeekViewStylesContains settings that allow you to define the appearance of the Week view’s visual elements.
WorkWeekViewRepresents a Work-Week View.
WorkWeekViewStylesContains settings that allow you to define the appearance of the Work Week view’s visual elements.

Delegates

NameDescription
ActiveViewChangingEventHandlerA method that will handle the ASPxScheduler.ActiveViewChanging event.
AppointmentFormEventHandlerA method that will handle the ASPxScheduler.AppointmentFormShowing event.
AppointmentImagesEventHandlerA method that will handle the ASPxScheduler.InitAppointmentImages event.
AppointmentInplaceEditorEventHandlerA method that will handle the ASPxScheduler.AppointmentInplaceEditorShowing event.
AppointmentViewInfoCustomizingEventHandlerA method that will handle the ASPxScheduler.AppointmentViewInfoCustomizing event.
ASPxSchedulerCustomErrorTextEventHandlerA method that will handle the ASPxScheduler.CustomErrorText event.
ASPxSchedulerDataDeletedEventHandlerA method that will handle the ASPxSchedulerDataWebControlBase.AppointmentRowDeleted event.
ASPxSchedulerDataDeletingEventHandlerA method that will handle the ASPxSchedulerDataWebControlBase.AppointmentRowDeleting event.
ASPxSchedulerDataInsertedEventHandlerA method that will handle the ASPxSchedulerDataWebControlBase.AppointmentRowInserted event.
ASPxSchedulerDataInsertingEventHandlerA method that will handle the ASPxSchedulerDataWebControlBase.AppointmentRowInserting event.
ASPxSchedulerDataUpdatedEventHandlerA method that will handle the ASPxSchedulerDataWebControlBase.AppointmentRowUpdated event.
ASPxSchedulerDataUpdatingEventHandlerA method that will handle the ASPxSchedulerDataWebControlBase.AppointmentRowUpdating event.
ASPxSchedulerPrepareFormPopupContainerHandlerA method that will handle the ASPxScheduler.PrepareAppointmentInplaceEditorPopupContainer, the ASPxScheduler.PrepareGotoDateFormPopupContainer, the ASPxScheduler.PrepareRecurrenceAppointmentDeleteFormPopupContainer, the ASPxScheduler.PrepareRecurrenceAppointmentEditFormPopupContainer, and the ASPxScheduler.PrepareRemindersFormPopupContainer events.
ASPxSchedulerTimeCellPreparedEventHandlerA method that will handle the ASPxScheduler.HtmlTimeCellPrepared event.
CustomizeElementStyleEventHandlerA method that will handle the ASPxScheduler.CustomizeElementStyle event.
GotoDateFormEventHandlerA method that will handle the ASPxScheduler.GotoDateFormShowing event.
InitClientAppointmentHandlerA method that will handle the ASPxScheduler.InitClientAppointment event.
PopupMenuShowingEventHandlerA method that will handle the ASPxScheduler.PopupMenuShowing event.
PreparePopupMenuEventHandlerObsolete. A method that will handle PreparePopupMenu event.
SchedulerCallbackCommandEventHandlerA method that will handle ASPxScheduler.BeforeExecuteCallbackCommand and ASPxScheduler.AfterExecuteCallbackCommand events.

Enums

NameDescription
AgendaDayHeaderOrientationLists values that specify the direction in which a day header is arranged in the Agenda View.
AgendaIconCellVisibilityLists values that specify when an icon cell is visible in the scheduler in Agenda View.
AgendaResourceLocationLists values that specify the Resource location.
AppointmentDatesHighlightModeLists values specifying how to highlight the Date Navigator’s dates that contains appointments.
AppointmentSelectionAppearanceModeLists values that specify how appointment selection is visually indicated.
AppointmentToolTipModeLists values specifying the tooltip mode for the scheduler’s appointments.
ASPxSchedulerChangeActionLists actions used to determine how the ASPxScheduler control instance should be updated.
AutoHeightModeLists modes for cell auto height behavior in certain views.
ResourceColorFillAreaLists values that specify what parts of a grouped view are filled with resource colors.
ResourceNavigatorModeLists values that specify the resource navigation mode.
SchedulerFormActionSpecifies the operation mode of the form.
SchedulerFormVisibilitySpecifies whether and how the scheduler form is displayed.
ToolTipCornerTypeLists designs applied to the tooltip form.
ViewVisibleIntervalRenderModeSpecifies the render mode of the View Visible Interval.
WebElementTypeSpecifies the web element type to which the custom style should be applied.