Skip to main content

DxScheduler Members

A calendar and scheduler component that displays a detailed snapshot of events/appointments in your web application across a single day, a week, or a month.

Constructors

Name Description
DxScheduler() Initializes a new DxScheduler class instance with the default settings.

Properties

Name Description
ActiveViewType Specifies the currently active view.
AllowCreateAppointment Specifies whether users can create new appointments.
AllowDeleteAppointment Specifies whether users can delete appointments.
AllowDragAppointment Specifies whether users can drag appointments.
AllowDragAppointmentBetweenResources Specifies whether users can drag-and-drop appointments between resource groups.
AllowEditAppointment Specifies whether users can edit appointments.
AllowResizeAppointment Specifies whether users can resize appointments.
AppointmentCompactFormHeaderTemplate Specifies the template for the compact edit form‘s header.
AppointmentCompactFormLayout Specifies the layout of the compact form that appears when a user creates or edits an appointment.
AppointmentFormHeaderTemplate Specifies the template for the extended edit form‘s header.
AppointmentFormLayout Specifies the layout of the extended form that appears when you create an appointment and click the expand button, or when you edit an appointment.
AppointmentFormMode Specifies which appointment form a user can use to create and edit appointments.
AppointmentTooltipHeaderTemplate Specifies the template for the appointment tooltip’s header.
AppointmentTooltipTemplate Specifies the template for an appointment tooltip.
CssClass Assign a CSS class to the component. Inherited from DxComponentBase.
DataStorage Specifies the Scheduler’s data source.
DateNavigatorTextTemplate Specifies the template used to display text in the Scheduler’s Date Navigator.
FirstDayOfWeek Specifies the first day of the week.
GroupType Specifies how Scheduler appointments are grouped.
Id Specifies the component’s unique identifier. Inherited from DxComponentBase.
InnerComponentSizeMode Specifies the size of the Scheduler’s inner components.
RecurrenceSettingsFormHeaderTemplate Specifies the template for the recurrence settings form’s header.
ResourceColorInHeaderVisible Specifies whether a resource color is applied to the corresponding group’s header.
ResourceNavigatorVisible Specifies whether the Scheduler displays the Resource Navigator.
SelectedAppointment Specifies the selected appointment.
ShowAppointmentTooltip Specifies whether to show an appointment’s tooltip.
StartDate Specifies the Scheduler’s start date.
ValidateEditForm Specifies whether to validate the appointment edit form.
Views Specifies the Scheduler’s view collection.
VisibleResourcesDataSource Specifies the data source that stores visible resource objects.
WorkDays Specifies days assigned to a workweek.

Methods

Name Description
ClosePopupAsync() Closes an appointment’s tooltip or edit form (compact or detailed).
CloseRecurrenceSettingsFormAsync() Closes the recurrence settings form.
CreateAppointmentAsync(DateTime, DateTime, Boolean, Object) Creates a new appointment for the Scheduler, but does not save it to a data source.
DeleteAppointmentAsync(DxSchedulerAppointmentItem) Deletes an appointment.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RestoreAppointmentOccurrenceAsync(DxSchedulerAppointmentItem) Restores occurrence for a recurring appointment.
SaveAppointmentAsync(DxSchedulerAppointmentItem) Saves appointment changes to a data source.
ScrollTo(DxSchedulerAppointmentItem) Scrolls the scheduler’s view area to the specified appointment.
ScrollTo(DateTime) Scrolls the scheduler’s view to the specified date and time.
ShowAppointmentEditFormAsync(Boolean, DxSchedulerAppointmentItem) Shows the appointment’s edit form.
ShowAppointmentTooltipAsync(DxSchedulerAppointmentItem) Shows an appointment tooltip.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
ActiveViewTypeChanged Fires after the active view is changed.
AppointmentCreated Fires after an appointment is created.
AppointmentCreating Fires before an appointment is created.
AppointmentDraggingBetweenResources Fires after a user drags an appointment to another resource group.
AppointmentFormClosed Fires after the appointment form is closed.
AppointmentFormClosing Fires before the appointment form is closed.
AppointmentFormShowing Fires before the appointment form is shown.
AppointmentFormShown Fires after an appointment form is shown.
AppointmentInserted Fires after a new appointment is added to the AppointmentsSource object.
AppointmentInserting Fires before a new appointment is added to the AppointmentsSource object.
AppointmentRemoved Fires after an appointment is removed from the AppointmentsSource object.
AppointmentRemoving Fires before an appointment is removed from the AppointmentsSource object.
AppointmentStartDragging Fires when a user starts dragging an appointment.
AppointmentStartResizing Fires when a user starts resizing an appointment.
AppointmentTooltipClosed Fires after an appointment tooltip is closed.
AppointmentTooltipClosing Fires before an appointment tooltip is closed.
AppointmentTooltipShowing Fires before an appointment tooltip is shown.
AppointmentTooltipShown Fires after an appointment tooltip is shown.
AppointmentUpdated Fires after an updated appointment is saved to the AppointmentsSource object.
AppointmentUpdating Fires before an updated appointment is saved to the AppointmentsSource object.
HtmlCellDecoration Allows you to customize the appearance of Scheduler cells.
SelectedAppointmentChanged Fires after the selected appointment is changed.
StartDateChanged Fires after the Scheduler start date is changed.
VisibleResourcesDataSourceChanged Occurs when the data source with visible resource objects changes.
See Also