Class
TelerikScheduler<TItem>

The class for the Telerik Scheduler component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:

cs-api-definition
public class TelerikScheduler<TItem> : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikScheduler<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

TelerikScheduler()

Declaration

cs-api-definition
public TelerikScheduler()

Properties

AllDayItemTemplate

Defines the template to be used when rendering all-day appointments. Used in Day, Week and Multiday views.

Declaration

cs-api-definition
[Parameter]
public RenderFragment<object> AllDayItemTemplate { get; set; }

Property Value

RenderFragment<object>

AllowCreate

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

Declaration

cs-api-definition
[Parameter]
public bool AllowCreate { get; set; }

Property Value

bool

AllowDelete

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

Declaration

cs-api-definition
[Parameter]
public bool AllowDelete { get; set; }

Property Value

bool

AllowUpdate

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

Declaration

cs-api-definition
[Parameter]
public bool AllowUpdate { get; set; }

Property Value

bool

ConfirmDelete

Defines whether deleting an appointment should be confirmed.

Declaration

cs-api-definition
[Parameter]
public bool ConfirmDelete { get; set; }

Property Value

bool

Data

Defines the data source of the Grid.

Declaration

cs-api-definition
[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

cs-api-definition
[Parameter]
public DateTime Date { get; set; }

Property Value

DateTime

DateChanged

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<DateTime> DateChanged { get; set; }

Property Value

EventCallback<DateTime>

DescriptionField

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

Declaration

cs-api-definition
[Parameter]
public string DescriptionField { get; set; }

Property Value

string

DialogFactory

Declaration

cs-api-definition
[CascadingParameter]
public DialogFactory DialogFactory { get; set; }

Property Value

DialogFactory

EnableLoaderContainer

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

Declaration

cs-api-definition
[Parameter]
public bool EnableLoaderContainer { get; set; }

Property Value

bool

EndField

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

Declaration

cs-api-definition
[Parameter]
public string EndField { get; set; }

Property Value

string

FocusedIndex

Declaration

cs-api-definition
public int FocusedIndex { get; set; }

Property Value

int

Height

Defines the height of the Scheduler.

Declaration

cs-api-definition
[Parameter]
public string Height { get; set; }

Property Value

string

Id

Specifies the id of the Component.

Declaration

cs-api-definition
[Parameter]
public string Id { get; set; }

Property Value

string

IdField

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

Declaration

cs-api-definition
[Parameter]
public string IdField { get; set; }

Property Value

string

IsAllDayField

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

Declaration

cs-api-definition
[Parameter]
public string IsAllDayField { get; set; }

Property Value

string

IsGrouped

Declaration

cs-api-definition
public bool IsGrouped { get; }

Property Value

bool

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

cs-api-definition
[Parameter]
public RenderFragment<object> ItemTemplate { get; set; }

Property Value

RenderFragment<object>

OnCancel

Fires when an action is cancelled.

Declaration

cs-api-definition
[Parameter]
public EventCallback<SchedulerCancelEventArgs> OnCancel { get; set; }

Property Value

EventCallback<SchedulerCancelEventArgs>

OnCellRender

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

Declaration

cs-api-definition
[Parameter]
public Action<SchedulerCellRenderEventArgs> OnCellRender { get; set; }

Property Value

Action<SchedulerCellRenderEventArgs>

OnCreate

Fires when an appointment is created.

Declaration

cs-api-definition
[Parameter]
public EventCallback<SchedulerCreateEventArgs> OnCreate { get; set; }

Property Value

EventCallback<SchedulerCreateEventArgs>

OnDelete

Fires when an appointment is deleted.

Declaration

cs-api-definition
[Parameter]
public EventCallback<SchedulerDeleteEventArgs> OnDelete { get; set; }

Property Value

EventCallback<SchedulerDeleteEventArgs>

OnEdit

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<SchedulerEditEventArgs> OnEdit { get; set; }

Property Value

EventCallback<SchedulerEditEventArgs>

OnItemClick

Fires when an appointment is clicked.

Declaration

cs-api-definition
[Parameter]
public EventCallback<SchedulerItemClickEventArgs> OnItemClick { get; set; }

Property Value

EventCallback<SchedulerItemClickEventArgs>

OnItemContextMenu

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<SchedulerItemContextMenuEventArgs> OnItemContextMenu { get; set; }

Property Value

EventCallback<SchedulerItemContextMenuEventArgs>

OnItemDoubleClick

Fires when an appointment is double-clicked.

Declaration

cs-api-definition
[Parameter]
public EventCallback<SchedulerItemDoubleClickEventArgs> OnItemDoubleClick { get; set; }

Property Value

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

cs-api-definition
[Parameter]
public Action<SchedulerItemRenderEventArgs> OnItemRender { get; set; }

Property Value

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

cs-api-definition
[Parameter]
public Func<TItem> OnModelInit { get; set; }

Property Value

Func<TItem>

OnUpdate

Fires when an appointment is updated.

Declaration

cs-api-definition
[Parameter]
public EventCallback<SchedulerUpdateEventArgs> OnUpdate { get; set; }

Property Value

EventCallback<SchedulerUpdateEventArgs>

RecurrenceExceptionsField

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

Declaration

cs-api-definition
[Parameter]
public string RecurrenceExceptionsField { get; set; }

Property Value

string

RecurrenceIdField

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

Declaration

cs-api-definition
[Parameter]
public string RecurrenceIdField { get; set; }

Property Value

string

RecurrenceRuleField

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

Declaration

cs-api-definition
[Parameter]
public string RecurrenceRuleField { get; set; }

Property Value

string

Resources

Declaration

cs-api-definition
public Dictionary<string, Resource> Resources { get; set; }

Property Value

Dictionary<string, Resource>

SchedulerResources

Defines the container for the Scheduler resources.

Declaration

cs-api-definition
[Parameter]
public RenderFragment SchedulerResources { get; set; }

Property Value

RenderFragment

SchedulerSettings

Defines the container for the Scheduler settings.

Declaration

cs-api-definition
[Parameter]
public RenderFragment SchedulerSettings { get; set; }

Property Value

RenderFragment

SchedulerToolBar

Defines the container for the Scheduler toolbar.

Declaration

cs-api-definition
[Parameter]
public RenderFragment SchedulerToolBar { get; set; }

Property Value

RenderFragment

SchedulerViews

Defines the container for the Scheduler views.

Declaration

cs-api-definition
[Parameter]
public RenderFragment SchedulerViews { get; set; }

Property Value

RenderFragment

SelectedView

Declaration

cs-api-definition
public ISchedulerView SelectedView { get; }

Property Value

ISchedulerView

StartField

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

Declaration

cs-api-definition
[Parameter]
public string StartField { get; set; }

Property Value

string

TitleField

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

Declaration

cs-api-definition
[Parameter]
public string TitleField { get; set; }

Property Value

string

View

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

Declaration

cs-api-definition
[Parameter]
public SchedulerView View { get; set; }

Property Value

SchedulerView

ViewChanged

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<SchedulerView> ViewChanged { get; set; }

Property Value

EventCallback<SchedulerView>

Width

Defines the width of the Scheduler.

Declaration

cs-api-definition
[Parameter]
public string Width { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Declaration

cs-api-definition
public override void Dispose()

Overrides BaseComponent.Dispose()

GetTimeSlotFromDropIndex(string)

Declaration

cs-api-definition
public TimeSlot GetTimeSlotFromDropIndex(string index)

Parameters

index

string

Returns

TimeSlot

GetWidgetOptions()

Declaration

cs-api-definition
protected virtual Dictionary<string, object> GetWidgetOptions()

Returns

Dictionary<string, object>

HideLoaderAsync()

Declaration

cs-api-definition
protected virtual Task HideLoaderAsync()

Returns

Task

OnAfterRenderAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

OnParametersSetAsync()

Declaration

cs-api-definition
protected override Task OnParametersSetAsync()

Returns

Task

Overrides ComponentBase.OnParametersSetAsync()

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

cs-api-definition
public virtual void Rebind()

Refresh()

Re-renders the component.

Declaration

cs-api-definition
public void Refresh()

SetParametersAsync(ParameterView)

Declaration

cs-api-definition
public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters

ParameterView

Returns

Task

Overrides ComponentBase.SetParametersAsync(ParameterView)

ShowLoaderAsync()

Declaration

cs-api-definition
protected virtual Task ShowLoaderAsync()

Returns

Task