Blazorise Scheduler: API Reference
Explore the Blazorise Scheduler API reference for appointments, views, events, templates, 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
Scheduler
| Parameter | Default | Type |
|---|---|---|
AllDayField | "AllDay" | string |
Specifies the field name of the Scheduler that represents the all-day status of the appointment. Defaults to "AllDay". | ||
ChildContent | null | RenderFragment |
Defines the content to be rendered inside the component. This property allows developers to define custom content within the Scheduler component. | ||
Data | null | IEnumerable<TItem> |
Holds a collection of items of type TItem. Used to manage and display a list of appointments. | ||
Date | null | DateOnly |
Specifies the anchor date used by the selected view. | ||
DefaultItemDuration | null | TimeSpan? |
Specifies the duration of new items created by clicking a timed slot. When null, zero, or negative, the clicked slot's duration is used. Explicit range selections and all-day items are unaffected. | ||
DeletedOccurrencesField | "DeletedOccurrences" | string |
Specifies 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. | ||
DescriptionField | "Description" | string |
Specifies the field name of the Scheduler that represents the description of the appointment. Defaults to "Description". | ||
Draggable | false | bool |
Indicates whether the items in the scheduler can be dragged and dropped. Defaults to false. | ||
Editable | false | bool |
Indicates whether the component is editable. Defaults to false. | ||
EndField | "End" | string |
Specifies the field name of the Scheduler that represents the end date of the appointment. Defaults to "End". | ||
IdField | "Id" | string |
Specifies the field name of the Scheduler that represents the unique identifier of the appointment. Defaults to "Id". | ||
Localizers | null | SchedulerLocalizers |
Custom localizer handlers to override default Scheduler localization. | ||
OriginalStartField | "OriginalStart" | string |
Specifies 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. | ||
RecurrenceExceptionsField | "RecurrenceExceptions" | string |
Specifies 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. | ||
RecurrenceIdField | "RecurrenceId" | string |
Specifies 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. | ||
RecurrenceRuleField | "RecurrenceRule" | string |
Specifies the field name of the Scheduler that represents the recurrence rule string in iCalendar (RFC 5545) compliance rules. | ||
SelectedView | SchedulerView.Day | SchedulerView |
The currently selected view. Determines the view that is displayed in the scheduler. Possible values: DayWeekWorkWeekMonth | ||
ShowToolbar | true | bool |
Indicates if the toolbar should be displayed. | ||
SlotSelectionMode | SchedulerSlotSelectionMode.Disabled | SchedulerSlotSelectionMode |
Indicates how the slots can be selected. Defaults to Disabled. Possible values: DisabledMouse | ||
StartField | "Start" | string |
Specifies the field name of the Scheduler that represents the start date of the appointment. Defaults to "Start". | ||
TitleField | "Title" | string |
Specifies the field name of the Scheduler that represents the title of the appointment. Defaults to "Title". | ||
UseInternalEditing | true | bool |
Indicates whether internal editing is enabled. Defaults to true. | ||
WeekNavigationMode | FirstDayOfWeek | SchedulerWeekNavigationMode |
The mode of the week navigation. Determines how the week navigation is handled. Possible values: CurrentDayFirstDayOfWeek | ||
SchedulerCommands
| Parameter | Default | Type |
|---|---|---|
CancelCommandAllowed | true | bool |
Controls the visibility of the cancel command in editing dialogs. Defaults to true. | ||
CancelCommandTemplate | null | RenderFragment<SchedulerCommandContext<TItem>> |
Customizes the cancel command in editing dialogs. Rendered only when CancelCommandAllowed is true. | ||
DeleteCommandAllowed | true | bool |
Controls the visibility of delete commands on items and in editing dialogs. Defaults to true. This setting does not prevent programmatic deletion. | ||
DeleteCommandTemplate | null | RenderFragment<SchedulerDeleteCommandContext<TItem>> |
Customizes the delete command on items and in editing dialogs. Rendered only when DeleteCommandAllowed is true. | ||
SaveCommandAllowed | true | bool |
Controls the visibility of the save command in editing dialogs. Defaults to true. | ||
SaveCommandTemplate | null | RenderFragment<SchedulerCommandContext<TItem>> |
Customizes the save command in editing dialogs. Rendered only when SaveCommandAllowed is true. | ||
Events
Scheduler
| Event | Type |
|---|---|
DateChanged | EventCallback<DateOnly> |
Notifies when the selected date changes. | |
DeleteItemClicked | EventCallback<SchedulerItemClickedEventArgs<TItem>> |
An event callback triggered when an item is clicked for deletion. | |
DragCancelled | Func<SchedulerDragEventArgs<TItem>, Task> |
Triggered when a drag operation is cancelled. | |
DragStarted | Func<SchedulerDragEventArgs<TItem>, Task> |
Triggered when a drag operation starts. | |
DropAllowed | Func<SchedulerDragEventArgs<TItem>, Task<bool>> |
Defines a function that determines if a drop action is allowed during a drag-and-drop operation. | |
EditItemClicked | EventCallback<SchedulerItemClickedEventArgs<TItem>> |
An event callback triggered when an item is clicked for editing. | |
ItemDropped | EventCallback<SchedulerItemDroppedEventArgs<TItem>> |
Triggered when an item is dropped into a new slot. | |
ItemInserted | EventCallback<SchedulerInsertedItem<TItem>> |
Triggers an event when a new item is inserted into the scheduler. | |
ItemInserting | EventCallback<SchedulerCancellableItemChange<TItem>> |
Triggers an event when a new item is being inserted into the scheduler. It allows handling and cancellation of the item insert process. | |
ItemRemoved | EventCallback<SchedulerUpdatedItem<TItem>> |
Triggers an event when an item in the scheduler is deleted. | |
ItemRemoving | EventCallback<SchedulerCancellableItemChange<TItem>> |
An event callback triggered when an item is being removed from the scheduler. It allows handling and cancellation of the removal process. | |
ItemStyling | Action<TItem, SchedulerItemStyling> |
Specifies a callback for customizing the styling of items in a Scheduler. | |
ItemUpdated | EventCallback<SchedulerUpdatedItem<TItem>> |
Triggers an event when an item in the scheduler is updated. | |
ItemUpdating | EventCallback<SchedulerCancellableItemChange<TItem>> |
An event callback triggered when an item is being updated in the scheduler. It allows handling and cancellation of the item update process. | |
NewIdCreator | Func<object> |
Defines a function that creates a new ID for the item. It allows for custom ID generation logic. | |
NewItemCreator | Func<TItem> |
Defines a function that creates a new item of type TItem. It allows for custom item creation logic. | |
SelectedViewChanged | EventCallback<SchedulerView> |
Notifies when the selected view changes. | |
SlotClicked | EventCallback<SchedulerSlotClickedEventArgs> |
Notifies when an empty slot is clicked. | |
SlotsSelected | EventCallback<SchedulerSlotsSelectedEventArgs> |
Notifies when an empty slot is clicked. | |
Methods
Scheduler
| Method | Return | Parameters |
|---|---|---|
Delete | Task | TItem item |
Deletes the specified item from the Data source.
| ||
EditOccurrence | Task | TItem item |
Opens the modal dialog for editing a single occurrence of a recurring item.
| ||
Edit | Task | TItem item |
Sets the Scheduler into the Edit state mode for the specified item.
| ||
NavigateNextPeriod | Task | — |
Navigates to the next date or period based on the current view mode of the scheduler.
| ||
NavigatePreviousPeriod | Task | — |
Navigates to the previous date or period based on the current view mode of the scheduler.
| ||
NavigateToday | Task | — |
Navigates to today's date, updating the selected date to the current day and refreshing the view.
| ||
New | Task | — |
Creates a new appointment by invoking the New() method with a newly created item.
| ||
New | Task | TItem item |
Creates a new item and sets the editing state to 'New'. If conditions are met, it displays a modal for editing the item.
| ||
Refresh | Task | — |
Triggers a re-evaluation of the component's state and rebuilds the visible scheduler view.
| ||
ShowDayView | Task | — |
Sets the selected view to 'Day' and triggers an update to reflect this change.
| ||
ShowMonthView | Task | — |
Sets the selected view to 'Month' and triggers an update to reflect this change.
| ||
ShowWeekView | Task | — |
Sets the selected view to 'Week' and triggers an update to reflect this change.
| ||
ShowWorkWeekView | Task | — |
Sets the selected view to 'WorkWeek' and triggers an update to reflect this change.
| ||