ClassTelerikScheduler<TItem>
The class for the Telerik Scheduler component.
Definition
Namespace:Telerik.Blazor.Components
Assembly:Telerik.Blazor.dll
Type Parameters:
TItem
Syntax:
public class TelerikScheduler<TItem> : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance: objectComponentBaseBaseComponentTelerikScheduler<TItem>
Implements:
Inherited Members
Constructors
TelerikScheduler()
Declaration
public TelerikScheduler()
Properties
AllDayItemTemplate
Defines the template to be used when rendering all-day appointments. Used in Day, Week and Multiday views.
Declaration
[Parameter]
public RenderFragment<object> AllDayItemTemplate { get; set; }
Property Value
AllowCreate
Determines whether or now creating new appointments is allowed. True by default.
AllowDelete
Determines whether or now deleting appointments is allowed. True by default.
AllowUpdate
Determines whether or now updating appointments is allowed. True by default.
ConfirmDelete
Defines whether deleting an appointment should be confirmed.
Declaration
[Parameter]
public bool ConfirmDelete { get; set; }
Property Value
Data
Defines the data source of the Grid.
Declaration
[Parameter]
public IEnumerable<TItem> Data { get; set; }
Property Value
IEnumerable<TItem>
Date
The currently selected date of the Scheduler. Determinse the period which is displayed.
Declaration
[Parameter]
public DateTime Date { get; set; }
Property Value
DateChanged
The handler that will be called when the currently selected date is changed.
Declaration
[Parameter]
public EventCallback<DateTime> DateChanged { get; set; }
Property Value
DescriptionField
Defines the DescriptionField of the Data. Default value: "Description".
Declaration
[Parameter]
public string DescriptionField { get; set; }
Property Value
DialogFactory
Declaration
[CascadingParameter]
public DialogFactory DialogFactory { get; set; }
Property Value
EnableLoaderContainer
Defines whether the loading container should be shown when there are long-running operations.
Declaration
[Parameter]
public bool EnableLoaderContainer { get; set; }
Property Value
EndField
Defines the EndField of the Data. Default value: "End".
Declaration
[Parameter]
public string EndField { get; set; }
Property Value
Height
Defines the height of the Scheduler.
Id
Specifies the id of the Component.
IdField
Defines the IdField of the Data. Default value: "Id".
IsAllDayField
Defines the IsAllDayField of the Data. Default value: "IsAllDay".
Declaration
[Parameter]
public string IsAllDayField { get; set; }
Property Value
ItemTemplate
Defines the template to be used when rendering appointments. Used in all views, and the Day Section of the Day, Week and Multiday views.
Declaration
[Parameter]
public RenderFragment<object> ItemTemplate { get; set; }
Property Value
OnCancel
Fires when an action is cancelled.
Declaration
[Parameter]
public EventCallback<SchedulerCancelEventArgs> OnCancel { get; set; }
Property Value
OnCellRender
Called each time a time slot is rendered. Use this to add custom classes to the time slot's element.
Declaration
[Parameter]
public Action<SchedulerCellRenderEventArgs> OnCellRender { get; set; }
Property Value
OnCreate
Fires when an appointment is created.
Declaration
[Parameter]
public EventCallback<SchedulerCreateEventArgs> OnCreate { get; set; }
Property Value
OnDelete
Fires when an appointment is deleted.
Declaration
[Parameter]
public EventCallback<SchedulerDeleteEventArgs> OnDelete { get; set; }
Property Value
OnEdit
Fires on double click on a slot or on an appointment. If cancelled, edit dialog will not be shown.
Declaration
[Parameter]
public EventCallback<SchedulerEditEventArgs> OnEdit { get; set; }
Property Value
OnItemClick
Fires when an appointment is clicked.
Declaration
[Parameter]
public EventCallback<SchedulerItemClickEventArgs> OnItemClick { get; set; }
Property Value
OnItemContextMenu
Fires when a context menu event is triggered on an appointment.
Declaration
[Parameter]
public EventCallback<SchedulerItemContextMenuEventArgs> OnItemContextMenu { get; set; }
Property Value
OnItemDoubleClick
Fires when an appointment is double-clicked.
Declaration
[Parameter]
public EventCallback<SchedulerItemDoubleClickEventArgs> OnItemDoubleClick { get; set; }
Property Value
OnItemRender
Called each time an appointment is rendered. Use this to add custom classes to the appointment element based on the data item.
Declaration
[Parameter]
public Action<SchedulerItemRenderEventArgs> OnItemRender { get; set; }
Property Value
OnModelInit
Fires when a new instance of the model is about to be created. Useful when no parameterless constructor is implemented. If the delegate is not defined Activator.CreateInstance method is used to create a new model instance.
Declaration
[Parameter]
public Func<TItem> OnModelInit { get; set; }
Property Value
Func<TItem>
OnUpdate
Fires when an appointment is updated.
Declaration
[Parameter]
public EventCallback<SchedulerUpdateEventArgs> OnUpdate { get; set; }
Property Value
RecurrenceExceptionsField
Defines the RecurrenceExceptionsField of the Data. Default value: "RecurrenceExceptions".
Declaration
[Parameter]
public string RecurrenceExceptionsField { get; set; }
Property Value
RecurrenceIdField
Defines the RecurrenceIdField of the Data, which is the Id of the recurrence parent. Default value: "RecurrenceId".
Declaration
[Parameter]
public string RecurrenceIdField { get; set; }
Property Value
RecurrenceRuleField
Defines the RecurrenceRuleField of the Data. Default value: "RecurrenceRule".
Declaration
[Parameter]
public string RecurrenceRuleField { get; set; }
Property Value
Resources
Declaration
public Dictionary<string, Resource> Resources { get; set; }
Property Value
Dictionary<string, Resource>
SchedulerResources
Defines the container for the Scheduler resources.
Declaration
[Parameter]
public RenderFragment SchedulerResources { get; set; }
Property Value
SchedulerSettings
Defines the container for the Scheduler settings.
Declaration
[Parameter]
public RenderFragment SchedulerSettings { get; set; }
Property Value
SchedulerToolBar
Defines the container for the Scheduler toolbar.
Declaration
[Parameter]
public RenderFragment SchedulerToolBar { get; set; }
Property Value
SchedulerViews
Defines the container for the Scheduler views.
Declaration
[Parameter]
public RenderFragment SchedulerViews { get; set; }
Property Value
SelectedView
Declaration
public ISchedulerView SelectedView { get; }
Property Value
ISchedulerView
StartField
Defines the StartField of the Data. Default value: "Start".
Declaration
[Parameter]
public string StartField { get; set; }
Property Value
TitleField
Defines the TitleField of the Data. Default value: "Title".
Declaration
[Parameter]
public string TitleField { get; set; }
Property Value
View
The currently selected view of the Scheduler. Determines the layout of the calendar view.
Declaration
[Parameter]
public SchedulerView View { get; set; }
Property Value
ViewChanged
The handler that will be called when the currently selected view is changed.
Declaration
[Parameter]
public EventCallback<SchedulerView> ViewChanged { get; set; }
Property Value
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
Overrides
Dispose()
Declaration
public override void Dispose()
Overrides
GetWidgetOptions()
Declaration
protected virtual Dictionary<string, object> GetWidgetOptions()
Returns
Rebind()
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()
SetParametersAsync(ParameterView)
Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
parameters
Returns
Overrides