Class TelerikScheduler<TItem>

The class for the Telerik Scheduler component.

Inheritance
System.Object
BaseComponent
TelerikScheduler<TItem>
Inherited Members
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll

Syntax

public class TelerikScheduler<TItem> : BaseComponent, IDisposable, ISchedulerViewContainer, ISchedulerResourceContainer, ISchedulerSettingsContainer, IPopupEditSettingsContainer, ISchedulerToolBar, ISchedulerState
Type Parameters
TItem

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
public RenderFragment<object> AllDayItemTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

AllowCreate

Determines whether or now creating new appointments is allowed. True by default.

Declaration
public bool AllowCreate { get; set; }
Property Value
System.Boolean

AllowDelete

Determines whether or now deleting appointments is allowed. True by default.

Declaration
public bool AllowDelete { get; set; }
Property Value
System.Boolean

AllowUpdate

Determines whether or now updating appointments is allowed. True by default.

Declaration
public bool AllowUpdate { get; set; }
Property Value
System.Boolean

ConfirmDelete

Defines whether deleting an appointment should be confirmed.

Declaration
public bool ConfirmDelete { get; set; }
Property Value
System.Boolean

Data

Defines the data source of the Grid.

Declaration
public IEnumerable<TItem> Data { get; set; }
Property Value
System.Collections.Generic.IEnumerable<TItem>

Date

The currently selected date of the Scheduler. Determinse the period which is displayed.

Declaration
public DateTime Date { get; set; }
Property Value
System.DateTime

DateChanged

The handler that will be called when the currently selected date is changed.

Declaration
public EventCallback<DateTime> DateChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<System.DateTime>

DescriptionField

Defines the DescriptionField of the Data. Default value: "Description".

Declaration
public string DescriptionField { get; set; }
Property Value
System.String

DialogFactory

Declaration
public DialogFactory DialogFactory { get; set; }
Property Value
DialogFactory

EnableLoaderContainer

Defines whether the loading container should be shown when there are long-running operations.

Declaration
public bool EnableLoaderContainer { get; set; }
Property Value
System.Boolean

EndField

Defines the EndField of the Data. Default value: "End".

Declaration
public string EndField { get; set; }
Property Value
System.String

FocusedIndex

Declaration
public int FocusedIndex { get; set; }
Property Value
System.Int32

Height

Defines the height of the Scheduler.

Declaration
public string Height { get; set; }
Property Value
System.String

Id

Specifies the id of the Component.

Declaration
public string Id { get; set; }
Property Value
System.String

IdField

Defines the IdField of the Data. Default value: "Id".

Declaration
public string IdField { get; set; }
Property Value
System.String

IsAllDayField

Defines the IsAllDayField of the Data. Default value: "IsAllDay".

Declaration
public string IsAllDayField { get; set; }
Property Value
System.String

IsGrouped

Declaration
public bool IsGrouped { get; }
Property Value
System.Boolean

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
public RenderFragment<object> ItemTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

OnCancel

Fires when an action is cancelled.

Declaration
public EventCallback<SchedulerCancelEventArgs> OnCancel { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SchedulerCancelEventArgs>

OnCellRender

Called each time a time slot is rendered. Use this to add custom classes to the time slot's element.

Declaration
public Action<SchedulerCellRenderEventArgs> OnCellRender { get; set; }
Property Value
System.Action<SchedulerCellRenderEventArgs>

OnCreate

Fires when an appointment is created.

Declaration
public EventCallback<SchedulerCreateEventArgs> OnCreate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SchedulerCreateEventArgs>

OnDelete

Fires when an appointment is deleted.

Declaration
public EventCallback<SchedulerDeleteEventArgs> OnDelete { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SchedulerDeleteEventArgs>

OnEdit

Fires on double click on a slot or on an appointment. If cancelled, edit dialog will not be shown.

Declaration
public EventCallback<SchedulerEditEventArgs> OnEdit { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SchedulerEditEventArgs>

OnItemClick

Fires when an appointment is clicked.

Declaration
public EventCallback<SchedulerItemClickEventArgs> OnItemClick { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SchedulerItemClickEventArgs>

OnItemContextMenu

Fires when a context menu event is triggered on an appointment.

Declaration
public EventCallback<SchedulerItemContextMenuEventArgs> OnItemContextMenu { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SchedulerItemContextMenuEventArgs>

OnItemDoubleClick

Fires when an appointment is double-clicked.

Declaration
public EventCallback<SchedulerItemDoubleClickEventArgs> OnItemDoubleClick { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SchedulerItemDoubleClickEventArgs>

OnItemRender

Called each time an appointment is rendered. Use this to add custom classes to the appointment element based on the data item.

Declaration
public Action<SchedulerItemRenderEventArgs> OnItemRender { get; set; }
Property Value
System.Action<SchedulerItemRenderEventArgs>

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
public Func<TItem> OnModelInit { get; set; }
Property Value
System.Func<TItem>

OnUpdate

Fires when an appointment is updated.

Declaration
public EventCallback<SchedulerUpdateEventArgs> OnUpdate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SchedulerUpdateEventArgs>

RecurrenceExceptionsField

Defines the RecurrenceExceptionsField of the Data. Default value: "RecurrenceExceptions".

Declaration
public string RecurrenceExceptionsField { get; set; }
Property Value
System.String

RecurrenceIdField

Defines the RecurrenceIdField of the Data, which is the Id of the recurrence parent. Default value: "RecurrenceId".

Declaration
public string RecurrenceIdField { get; set; }
Property Value
System.String

RecurrenceRuleField

Defines the RecurrenceRuleField of the Data. Default value: "RecurrenceRule".

Declaration
public string RecurrenceRuleField { get; set; }
Property Value
System.String

Resources

Declaration
public Dictionary<string, Resource> Resources { get; set; }
Property Value
System.Collections.Generic.Dictionary<System.String, Telerik.Blazor.Components.Scheduler.Models.Resource>

SchedulerResources

Defines the container for the Scheduler resources.

Declaration
public RenderFragment SchedulerResources { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

SchedulerSettings

Defines the container for the Scheduler settings.

Declaration
public RenderFragment SchedulerSettings { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

SchedulerToolBar

Defines the container for the Scheduler toolbar.

Declaration
public RenderFragment SchedulerToolBar { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

SchedulerViews

Defines the container for the Scheduler views.

Declaration
public RenderFragment SchedulerViews { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

SelectedView

Declaration
public ISchedulerView SelectedView { get; }
Property Value
Telerik.Blazor.Components.Scheduler.ISchedulerView

StartField

Defines the StartField of the Data. Default value: "Start".

Declaration
public string StartField { get; set; }
Property Value
System.String

TitleField

Defines the TitleField of the Data. Default value: "Title".

Declaration
public string TitleField { get; set; }
Property Value
System.String

View

The currently selected view of the Scheduler. Determines the layout of the calendar view.

Declaration
public SchedulerView View { get; set; }
Property Value
SchedulerView

ViewChanged

The handler that will be called when the currently selected view is changed.

Declaration
public EventCallback<SchedulerView> ViewChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SchedulerView>

Width

Defines the width of the Scheduler.

Declaration
public string Width { get; set; }
Property Value
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

Dispose()

Declaration
public override void Dispose()
Overrides

GetTimeSlotFromDropIndex(String)

Declaration
public TimeSlot GetTimeSlotFromDropIndex(string index)
Parameters
System.String index

Returns
TimeSlot

GetWidgetOptions()

Declaration
protected virtual Dictionary<string, object> GetWidgetOptions()
Returns
System.Collections.Generic.Dictionary<System.String, System.Object>

HideLoaderAsync()

Declaration
protected virtual Task HideLoaderAsync()
Returns
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
System.Boolean firstRender

Returns
System.Threading.Tasks.Task

Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
System.Threading.Tasks.Task

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
Microsoft.AspNetCore.Components.ParameterView parameters

Returns
System.Threading.Tasks.Task

ShowLoaderAsync()

Declaration
protected virtual Task ShowLoaderAsync()
Returns
System.Threading.Tasks.Task