Blazorise Scheduler: API Reference

Explore the API reference for the Blazorise Scheduler component, detailing available attributes and methods.

For examples and details on the usage of this component, visit the example page: Scheduler

The Blazorise Scheduler component provides a comprehensive API for managing and customizing the scheduler's behavior. Below is a detailed reference of the available attributes and methods.

API

Parameters

Parameter	Description	Type	Default
`AllDayField`	Defines the field name of the Scheduler that represents the all-day status of the appointment. Defaults to "AllDay".	`string`	`"AllDay"`
`ChildContent`	Gets or sets the content to be rendered inside the component. Remarks This property allows developers to define custom content within the Scheduler component.	`RenderFragment`	`null`
`Data`	Holds a collection of items of type . Used to manage and display a list of appointments.	`IEnumerable<TItem>`	`null`
`Date`	The currently selected date. Determines the date that is displayed in the scheduler. Defaults to the current date.	`DateOnly`	`null`
`DeletedOccurrencesField`	Defines the field name of the Scheduler that represents the deleted occurrences. This is used to store the dates of the deleted occurrences in a recurring series.	`string`	`"DeletedOccurrences"`
`DescriptionField`	Defines the field name of the Scheduler that represents the description of the appointment. Defaults to "Description".	`string`	`"Description"`
`Draggable`	Indicates whether the items in the scheduler can be dragged and dropped. Defaults to false.	`bool`	`false`
`Editable`	Indicates whether the component is editable. Defaults to false.	`bool`	`false`
`EndField`	Defines the field name of the Scheduler that represents the end date of the appointment. Defaults to "End".	`string`	`"End"`
`IdField`	Defines the field name of the Scheduler that represents the unique identifier of the appointment. Defaults to "Id".	`string`	`"Id"`
`Localizers`	Custom localizer handlers to override default Scheduler localization.	`SchedulerLocalizers`	`null`
`OriginalStartField`	Defines the field name of the Scheduler that represents the original start date of the appointment. This is used to store the original start date of a recurring series.	`string`	`"OriginalStart"`
`RecurrenceExceptionsField`	Defines the field name of the Scheduler that represents the recurrence exceptions. This is used to store the dates of the exceptions in a recurring series.	`string`	`"RecurrenceExceptions"`
`RecurrenceIdField`	Defines the field name of the Scheduler that represents the recurrence ID of the appointment. This is used to identify the master appointment in a recurring series.	`string`	`"RecurrenceId"`
`RecurrenceRuleField`	Defines the field name of the Scheduler that represents the recurrence rule string in iCalendar (RFC 5545) compliance rules.	`string`	`"RecurrenceRule"`
`SelectedView`	The currently selected view. Determines the view that is displayed in the scheduler. Possible values:`Day`, `Week`, `WorkWeek`, `Month`	`SchedulerView`	`SchedulerView.Day`
`ShowToolbar`	Indicates if the toolbar should be displayed.	`bool`	`true`
`SlotSelectionMode`	Indicates how the slots can be selected. Defaults to Disabled. Possible values:`Disabled`, `Mouse`	`SchedulerSlotSelectionMode`	`SchedulerSlotSelectionMode.Disabled`
`StartField`	Defines the field name of the Scheduler that represents the start date of the appointment. Defaults to "Start".	`string`	`"Start"`
`TitleField`	Defines the field name of the Scheduler that represents the title of the appointment. Defaults to "Title".	`string`	`"Title"`
`UseInternalEditing`	Indicates whether internal editing is enabled. Defaults to true.	`bool`	`true`
`WeekNavigationMode`	The mode of the week navigation. Determines how the week navigation is handled. Possible values:`CurrentDay`, `FirstDayOfWeek`	`SchedulerWeekNavigationMode`	`SchedulerWeekNavigationMode.FirstDayOfWeek`

Events

Event	Description	Type
`DateChanged`	Occurs when the selected date changes.	`EventCallback<DateOnly>`
`DeleteItemClicked`	An event callback triggered when an item is clicked for deletion.	`EventCallback<SchedulerItemClickedEventArgs<TItem>>`
`DragCancelled`	Triggered when a drag operation is cancelled.	`Func<SchedulerDragEventArgs<TItem>, Task>`
`DragStarted`	Triggered when a drag operation starts.	`Func<SchedulerDragEventArgs<TItem>, Task>`
`DropAllowed`	Defines a function that determines if a drop action is allowed during a drag-and-drop operation.	`Func<SchedulerDragEventArgs<TItem>, Task<bool>>`
`EditItemClicked`	An event callback triggered when an item is clicked for editing.	`EventCallback<SchedulerItemClickedEventArgs<TItem>>`
`ItemDropped`	Triggered when an item is dropped into a new slot.	`EventCallback<SchedulerItemDroppedEventArgs<TItem>>`
`ItemInserted`	Triggers an event when a new item is inserted into the scheduler.	`EventCallback<SchedulerInsertedItem<TItem>>`
`ItemInserting`	Triggers an event when a new item is being inserted into the scheduler. It allows handling and cancellation of the item insert process.	`EventCallback<SchedulerCancellableItemChange<TItem>>`
`ItemRemoved`	Triggers an event when an item in the scheduler is deleted.	`EventCallback<SchedulerUpdatedItem<TItem>>`
`ItemRemoving`	An event callback triggered when an item is being removed from the scheduler. It allows handling and cancellation of the removal process.	`EventCallback<SchedulerCancellableItemChange<TItem>>`
`ItemStyling`	Defines a callback for customizing the styling of items in a Scheduler.	`Action<TItem, SchedulerItemStyling>`
`ItemUpdated`	Triggers an event when an item in the scheduler is updated.	`EventCallback<SchedulerUpdatedItem<TItem>>`
`ItemUpdating`	An event callback triggered when an item is being updated in the scheduler. It allows handling and cancellation of the item update process.	`EventCallback<SchedulerCancellableItemChange<TItem>>`
`NewIdCreator`	Defines a function that creates a new ID for the item. It allows for custom ID generation logic.	`Func<object>`
`NewItemCreator`	Defines a function that creates a new item of type TItem. It allows for custom item creation logic.	`Func<TItem>`
`SelectedViewChanged`	Occurs when the selected view changes.	`EventCallback<SchedulerView>`
`SlotClicked`	Occurs when an empty slot is clicked.	`EventCallback<SchedulerSlotClickedEventArgs>`
`SlotsSelected`	Occurs when an empty slot is clicked.	`EventCallback<SchedulerSlotsSelectedEventArgs>`

Methods

Method	Description	Return	Parameters
`NavigatePreviousPeriod`	Navigates to the previous date or period based on the current view mode of the scheduler.	`Task`
`NavigateNextPeriod`	Navigates to the next date or period based on the current view mode of the scheduler.	`Task`
`NavigateToday`	Navigates to today's date, updating the selected date to the current day and refreshing the view.	`Task`
`ShowDayView`	Sets the selected view to 'Day' and triggers an update to reflect this change.	`Task`
`ShowWeekView`	Sets the selected view to 'Week' and triggers an update to reflect this change.	`Task`
`ShowWorkWeekView`	Sets the selected view to 'WorkWeek' and triggers an update to reflect this change.	`Task`
`ShowMonthView`	Sets the selected view to 'Month' and triggers an update to reflect this change.	`Task`
`New`	Creates a new appointment by invoking the New() method with a newly created item.	`Task`
`New`	Creates a new item and sets the editing state to 'New'. If conditions are met, it displays a modal for editing the item.	`Task`	`TItem item`
`Edit`	Sets the Scheduler into the Edit state mode for the specified item.	`Task`	`TItem item`
`Delete`	Deletes the specified item from the Data source.	`Task`	`TItem item`
`EditOccurrence`	Opens the modal dialog for editing a single occurrence of a recurring item.	`Task`	`TItem item`
`CancelSelection`	Cancels the current selection if a transaction is in progress, rolling back any changes made during the selection. Should not be called directly by the user!	`Task`

Blazorise Scheduler: API Reference

API

Parameters

Events

Methods

On this page