Class

TelerikScheduler<TItem>

Declaration

public TelerikScheduler()

Customizes the visual appearance of all-day appointments. Receives the appointment data object as context. Used specifically for appointments marked as all-day in Day, Week and MultiDay views. These appointments appear in a dedicated section above the hourly time slots.

Declaration

[Parameter]
public RenderFragment<object> AllDayItemTemplate { get; set; }

Property Value

Controls whether users can create new appointments in the Scheduler. When enabled, users can create appointments by double-clicking empty time slots or using the toolbar. Requires the OnCreate event handler to persist new appointments.

Declaration

[Parameter]
public bool AllowCreate { get; set; }

Property Value

Controls whether users can delete existing appointments from the Scheduler. When enabled, users can remove appointments through context menus or keyboard shortcuts. Requires the OnDelete event handler to complete the deletion.

Declaration

[Parameter]
public bool AllowDelete { get; set; }

Property Value

Controls whether users can edit existing appointments in the Scheduler. When enabled, users can modify appointments by double-clicking them or using context menus. Requires the OnUpdate event handler to save changes.

Declaration

[Parameter]
public bool AllowUpdate { get; set; }

Property Value

Controls whether appointment deletion requires user confirmation. When enabled, shows a confirmation dialog before proceeding with deletion. Helps prevent accidental appointment removal.

Declaration

[Parameter]
public bool ConfirmDelete { get; set; }

Property Value

Provides the appointment data that populates the Scheduler. Should be a collection of objects containing appointment information like title, start/end times, and other properties. The field names are configurable through properties like TitleField, StartField, and EndField.

Declaration

[Parameter]
public IEnumerable<TItem> Data { get; set; }

Property Value

Sets the currently displayed date in the Scheduler. Determines which time period is visible based on the selected View. For example, in Day view shows that specific day, in Month view shows the month containing this date.

Declaration

[Parameter]
public DateTime Date { get; set; }

Property Value

Fires when the user navigates to a different date through the toolbar navigation or date picker. Provides the new selected date that determines the visible time period.

Declaration

[Parameter]
public EventCallback<DateTime> DateChanged { get; set; }

Property Value

Specifies which property contains detailed appointment information in your data objects. Typically used in the edit form to provide additional context about the appointment. Example: "Details" or "Notes".

Declaration

[Parameter]
public string DescriptionField { get; set; }

Property Value

Declaration

[CascadingParameter]
public DialogFactory DialogFactory { get; set; }

Property Value

Controls whether a loading overlay appears during data operations and view changes. When enabled, provides visual feedback during appointment creation, updates, deletions, and view transitions.

Declaration

[Parameter]
public bool EnableLoaderContainer { get; set; }

Property Value

Specifies which property contains the appointment end date and time in your data objects. Must be a DateTime value that determines when the appointment ends. Example: "EndDate" or "FinishTime".

Declaration

[Parameter]
public string EndField { get; set; }

Property Value

Declaration

public int FocusedIndex { get; set; }

Property Value

Controls the height of the Scheduler component. Accepts CSS values like "400px", "100%", or "50vh". Setting the height enables proper scrolling behavior.

Declaration

[Parameter]
public string Height { get; set; }

Property Value

Sets the unique HTML id attribute for the Scheduler component. Useful for custom styling, accessibility, or JavaScript integration. Example: "my-scheduler".

Declaration

[Parameter]
public string Id { get; set; }

Property Value

Specifies which property contains the unique identifier for appointments in your data objects. Required for proper CRUD operations and appointment tracking. Should be a unique value per appointment. Example: "AppointmentId" or "EventId".

Declaration

[Parameter]
public string IdField { get; set; }

Property Value

Specifies which property indicates whether an appointment spans the entire day in your data objects. Must be a boolean value. All-day appointments appear in a dedicated section above time slots in Day, Week, and MultiDay views. Example: "AllDay" or "FullDay".

Declaration

[Parameter]
public string IsAllDayField { get; set; }

Property Value

Declaration

public bool IsGrouped { get; }

Property Value

Customizes the visual appearance of regular appointments in all views. Receives the appointment data object as context. Use this to display appointment details beyond the default title. Applied to appointments in the main time section of Day, Week, and MultiDay views, and all appointments in Month, Timeline, and Agenda views.

Declaration

[Parameter]
public RenderFragment<object> ItemTemplate { get; set; }

Property Value

Fires when a user cancels an edit or create operation by closing dialogs without saving. Use this event to perform cleanup operations or revert any temporary changes made during the editing process.

Declaration

[Parameter]
public EventCallback<SchedulerCancelEventArgs> OnCancel { get; set; }

Property Value

Fires during time slot rendering to allow custom styling of calendar cells. Use this to highlight specific dates, mark holidays, or apply conditional styling based on date properties. Called for each visible time slot in the current view.

Declaration

[Parameter]
public Action<SchedulerCellRenderEventArgs> OnCellRender { get; set; }

Property Value

Fires when a user creates a new appointment through double-clicking time slots or using the toolbar. Handle this event to add the new appointment to your data source. The event provides the appointment details entered by the user.

Declaration

[Parameter]
public EventCallback<SchedulerCreateEventArgs> OnCreate { get; set; }

Property Value

Fires when a user confirms deletion of an appointment through context menus or keyboard shortcuts. Handle this event to remove the appointment from your data source. The event provides the appointment data to be deleted.

Declaration

[Parameter]
public EventCallback<SchedulerDeleteEventArgs> OnDelete { get; set; }

Property Value

Fires when a user attempts to edit an appointment by double-clicking it or accessing edit through context menus. Cancel this event to prevent the edit dialog from opening. Use this for conditional editing based on appointment properties or user permissions.

Declaration

[Parameter]
public EventCallback<SchedulerEditEventArgs> OnEdit { get; set; }

Property Value

Fires when a user clicks on an appointment in any view. Use this event to show appointment details, trigger custom actions, or handle appointment selection. Provides the clicked appointment data and mouse event information.

Declaration

[Parameter]
public EventCallback<SchedulerItemClickEventArgs> OnItemClick { get; set; }

Property Value

Fires when a user right-clicks on an appointment to trigger context menu actions. Use this event to show custom context menus or handle right-click behaviors specific to appointments. Provides the right-clicked appointment data and mouse event information.

Declaration

[Parameter]
public EventCallback<SchedulerItemContextMenuEventArgs> OnItemContextMenu { get; set; }

Property Value

Fires when a user double-clicks on an appointment in any view. By default, double-clicking opens the edit dialog. Use this event for custom double-click behavior. Provides the double-clicked appointment data and mouse event information.

Declaration

[Parameter]
public EventCallback<SchedulerItemDoubleClickEventArgs> OnItemDoubleClick { get; set; }

Property Value

Fires during appointment rendering to allow custom styling based on appointment data. Use this to add CSS classes, modify appearance, or set conditional styling based on appointment properties. Called for each visible appointment in the current view.

Declaration

[Parameter]
public Action<SchedulerItemRenderEventArgs> OnItemRender { get; set; }

Property Value

Provides a factory function for creating new appointment instances when the default constructor is unavailable. Called during appointment creation to initialize new data objects with default values or required properties. If not specified, the component uses Activator.CreateInstance to create new appointment objects.

Declaration

[Parameter]
public Func<TItem> OnModelInit { get; set; }

Property Value

Fires when a user saves changes to an existing appointment through the edit dialog. Handle this event to update the appointment in your data source. The event provides both original and modified appointment data.

Declaration

[Parameter]
public EventCallback<SchedulerUpdateEventArgs> OnUpdate { get; set; }

Property Value

Specifies which property contains dates when recurring appointments should be skipped in your data objects. Used to exclude specific occurrences from recurring appointment series. Should be a collection of DateTime values. Example: "ExceptionDates" or "SkippedDates".

Declaration

[Parameter]
public string RecurrenceExceptionsField { get; set; }

Property Value

Specifies which property contains the parent appointment ID for recurring appointment exceptions in your data objects. Links exception appointments to their parent recurring series using the parent's IdField value. Example: "MasterEventId" or "ParentAppointmentId".

Declaration

[Parameter]
public string RecurrenceIdField { get; set; }

Property Value

Specifies which property contains recurrence pattern rules in your data objects. Used for repeating appointments. Should contain recurrence rule strings in standard format. Example: "RecurrenceRule" or "RepeatRule".

Declaration

[Parameter]
public string RecurrenceRuleField { get; set; }

Property Value

Declaration

public Dictionary<string, Resource> Resources { get; set; }

Property Value

Defines the container for the Scheduler resources. Children: SchedulerResource tags.

Declaration

[Parameter]
public RenderFragment SchedulerResources { get; set; }

Property Value

Defines the container for the Scheduler settings. Children: SchedulerGroupSettings.

Declaration

[Parameter]
public RenderFragment SchedulerSettings { get; set; }

Property Value

Defines the container for the Scheduler toolbar that appears above the calendar views. Contains navigation controls, date picker, and view selection tools. When not specified, displays default navigation and view selection tools. Children: SchedulerToolBarCustomTool, SchedulerToolBarNavigationTool, SchedulerToolBarCalendarTool, SchedulerToolBarViewsTool .

Declaration

[Parameter]
public RenderFragment SchedulerToolBar { get; set; }

Property Value

Defines the container for the Scheduler views. Children: SchedulerDayView, SchedulerWeekView, SchedulerMultiDayView, SchedulerMonthView, SchedulerTimelineView, SchedulerAgendaView.

Declaration

[Parameter]
public RenderFragment SchedulerViews { get; set; }

Property Value

Declaration

public ISchedulerView SelectedView { get; }

Property Value

Specifies which property contains the appointment start date and time in your data objects. Must be a DateTime value that determines when the appointment begins. Example: "StartDate" or "BeginTime".

Declaration

[Parameter]
public string StartField { get; set; }

Property Value

Specifies which property contains the appointment title text in your data objects. The title appears as the main text displayed within appointments in all views. Example: "Subject" or "EventName".

Declaration

[Parameter]
public string TitleField { get; set; }

Property Value

Controls which calendar view is currently active in the Scheduler. Day displays a single day with hourly time slots. Week shows a full week with daily columns. Month presents a monthly calendar view. MultiDay displays a custom number of days side by side. Timeline shows appointments in a horizontal timeline format. Agenda presents appointments in a list format.

Declaration

[Parameter]
public SchedulerView View { get; set; }

Property Value

Fires when the user switches between different calendar views using the toolbar view selector. Provides the newly selected SchedulerView that determines the layout and time period display.

Declaration

[Parameter]
public EventCallback<SchedulerView> ViewChanged { get; set; }

Property Value

Controls the width of the Scheduler component. Accepts CSS values like "800px", "100%", or "auto". If not set, the Scheduler takes the full width of its container.

Declaration

[Parameter]
public string Width { get; set; }

Property Value

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Declaration

public override void Dispose()

Overrides BaseComponent.Dispose()

Declaration

public TimeSlot GetTimeSlotFromDropIndex(string index)

Parameters

Returns

Declaration

protected virtual Dictionary<string, object> GetWidgetOptions()

Returns

Declaration

protected virtual Task HideLoaderAsync()

Returns

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

Overrides BaseComponent.OnAfterRenderAsync(bool)

Declaration

protected override Task OnParametersSetAsync()

Returns

Overrides ComponentBase.OnParametersSetAsync()

Processes the available data with applied all data operations. Useful in scenarios where the data might change from an outside source. If the component contains OnRead, the method triggers the event so that fresh data can be supplied.

Declaration

public virtual void Rebind()

Re-renders the component.

Declaration

public void Refresh()

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Returns

Overrides ComponentBase.SetParametersAsync(ParameterView)

Declaration

protected virtual Task ShowLoaderAsync()

Returns