Back to Devexpress

DxScheduler Members

blazor-devexpress-dot-blazor-dot-dxscheduler-dot-underscore-members.md

latest14.4 KB
Original Source

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

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

Properties

NameDescription
ActiveViewTypeSpecifies the currently active view.
AllowCreateAppointmentSpecifies whether users can create new appointments.
AllowDeleteAppointmentSpecifies whether users can delete appointments.
AllowDragAppointmentSpecifies whether users can drag appointments.
AllowDragAppointmentBetweenResourcesSpecifies whether users can drag-and-drop appointments between resource groups.
AllowEditAppointmentSpecifies whether users can edit appointments.
AllowResizeAppointmentSpecifies whether users can resize appointments.
AppointmentCompactFormHeaderTemplateSpecifies the template for the compact edit form‘s header.
AppointmentCompactFormLayoutSpecifies the layout of the compact form that appears when a user creates or edits an appointment.
AppointmentDragModeSpecifies appointment drag & drop processing mode.
AppointmentFormHeaderTemplateSpecifies the template for the extended edit form‘s header.
AppointmentFormLayoutSpecifies the layout of the extended form that appears when you create an appointment and click the expand button, or when you edit an appointment.
AppointmentFormModeSpecifies which appointment form a user can use to create and edit appointments.
AppointmentTooltipHeaderTemplateSpecifies the template for the appointment tooltip’s header.
AppointmentTooltipTemplateSpecifies the template for an appointment tooltip.
AttributesSpecifies a collection of standard HTML attributes applied to the Scheduler.
ChildContentSpecifies the view collection.
CssClassAssigns a CSS class to the DxScheduler component.
DataStorageSpecifies the Scheduler’s data source.
DateNavigatorTextTemplateSpecifies the template used to display text in the Scheduler’s Date Navigator.
FirstDayOfWeekSpecifies the first day of the week.
GroupTypeSpecifies how Scheduler appointments are grouped.
IdSpecifies the DxScheduler component’s unique identifier.
InnerComponentSizeModeSpecifies the size of the Scheduler’s inner components.
PopupSettingsSpecifies settings for pop-up Scheduler elements (extended and compact appointment forms and tooltips).
RecurrenceSettingsFormHeaderTemplateSpecifies the template for the recurrence settings form’s header.
ResourceColorInHeaderVisibleSpecifies whether a resource color is applied to the corresponding group’s header.
ResourceNavigatorVisibleSpecifies whether the Scheduler displays the Resource Navigator.
SelectedAppointmentSpecifies the selected appointment.
ShowAppointmentTooltipSpecifies whether to show an appointment’s tooltip.
ShowToolbarAreaSpecifies whether to display the toolbar.
StartDateSpecifies the Scheduler’s start date.
ToolbarItemsSpecifies the collection of toolbar items.
ValidateEditFormSpecifies whether to validate the appointment edit form.
ViewsSpecifies the Scheduler’s view collection.
VisibleResourcesDataSourceSpecifies the data source that stores visible resource objects.
WorkDaysSpecifies days assigned to a workweek.

Methods

NameDescription
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) staticDetermines 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() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines 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, DxSchedulerResourceItem)Shows an appointment tooltip.
ToString()Returns a string that represents the current object. Inherited from Object.

Events

NameDescription
ActiveViewTypeChangedFires after the active view is changed.
AppointmentCreatedFires after an appointment is created.
AppointmentCreatingFires before an appointment is created.
AppointmentDraggingBetweenResourcesFires after a user drags an appointment to another resource group.
AppointmentFormClosedFires after the appointment form is closed.
AppointmentFormClosingFires before the appointment form is closed.
AppointmentFormShowingFires before the appointment form is shown.
AppointmentFormShownFires after an appointment form is shown.
AppointmentInsertedFires after a new appointment is added to the AppointmentsSource object.
AppointmentInsertingFires before a new appointment is added to the AppointmentsSource object.
AppointmentRemovedFires after an appointment is removed from the AppointmentsSource object.
AppointmentRemovingFires before an appointment is removed from the AppointmentsSource object.
AppointmentStartDraggingFires when a user starts dragging an appointment.
AppointmentStartResizingFires when a user starts resizing an appointment.
AppointmentTooltipClosedFires after an appointment tooltip is closed.
AppointmentTooltipClosingFires before an appointment tooltip is closed.
AppointmentTooltipShowingFires before an appointment tooltip is shown.
AppointmentTooltipShownFires after an appointment tooltip is shown.
AppointmentUpdatedFires after an updated appointment is saved to the AppointmentsSource object.
AppointmentUpdatingFires before an updated appointment is saved to the AppointmentsSource object.
HtmlCellDecorationAllows you to customize the appearance of Scheduler cells.
SelectedAppointmentChangedFires after the selected appointment is changed.
StartDateChangedFires after the Scheduler start date is changed.
VisibleResourcesDataSourceChangedOccurs when the data source with visible resource objects changes.

See Also

DxScheduler Class

DevExpress.Blazor Namespace