Class TelerikCalendar

The Calendar component class.

Inheritance
System.Object
BaseComponent
TelerikCalendar
Inherited Members
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll

Syntax

public class TelerikCalendar : BaseComponent, IDisposable

Constructors

TelerikCalendar()

Declaration
public TelerikCalendar()

Properties

AllowReverse

Defines if the end date can precede the start date.

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

BottomView

Defines the bottommost view to which the user can navigate. Default value is Month.

Declaration
public CalendarView BottomView { get; set; }
Property Value
CalendarView

CenturyCellTemplate

The template that will be used when rendering date cells in Century View.

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

Date

Sets the date to which the calendar will navigate.

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

DateChanged

The handler that will be called when the user navigates to a different date.

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

DecadeCellTemplate

The template that will be used when rendering date cells in Decade View.

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

DisabledDates

Specifies a list of dates that can not be selected.

Declaration
public List<DateTime> DisabledDates { get; set; }
Property Value
System.Collections.Generic.List<System.DateTime>

HeaderTemplate

Specifies the header template.

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

Max

Sets the maximum allowed date of the calendar.

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

Min

Sets the minimum allowed date of the calendar.

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

MonthCellTemplate

The template that will be used when rendering date cells in Month View.

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

OnCellRender

Called each time a cell is rendered. Use this to add custom classes to the cell based on the date.

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

Orientation

Specifies the orientation of the calendar when multiple views are present. The available vaues are Horizontal (default) and Vertical.

Declaration
public CalendarOrientation Orientation { get; set; }
Property Value
CalendarOrientation

RangeEnd

The end selected date in CalendarSelectionMode.Range.

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

RangeEndChanged

The handler that will be called when range end changes.

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

RangeStart

The start selected date in CalendarSelectionMode.Range.

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

RangeStartChanged

The handler that will be called when range start changes.

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

SelectedDates

Gets or sets the selected dates when multi-selection is enabled.

Declaration
public List<DateTime> SelectedDates { get; set; }
Property Value
System.Collections.Generic.List<System.DateTime>

SelectionMode

Sets the selection mode of the calendar. Default value is Single.

Declaration
public CalendarSelectionMode SelectionMode { get; set; }
Property Value
CalendarSelectionMode

ShowOtherMonthDays

Defines if the days from adjacent months are shown.

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

ShowWeekNumbers

Defines if additional week number column is added.

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

Size

Specifies the Size of the calendar. Default value is Medium.

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

TopView

Defines the topmost view to which the user can navigate. Default value is Century.

Declaration
public CalendarView TopView { get; set; }
Property Value
CalendarView

Value

Sets the value of the calendar when single selection is used.

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

ValueChanged

The handler that will be called when the user selects date(s).

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

View

Specifies the current view that will be displayed. See CalendarView.

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

ViewChanged

The handler that will be called when the user navigates to a different view.

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

Views

Defines the number of views that will be rendered next to each other. Default value is 1.

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

YearCellTemplate

The template that will be used when rendering date cells in Year View.

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

Methods

BuildRenderTree(RenderTreeBuilder)

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

NavigateTo(DateTime, CalendarView)

Moves the calendar to specific date in a view.

Declaration
public void NavigateTo(DateTime date, CalendarView view)
Parameters
System.DateTime date

The date to which to navigate.
CalendarView view

The view to which to navigate.

OnAfterRenderAsync(Boolean)

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

Returns
System.Threading.Tasks.Task

Overrides

OnHeaderTitleClick()

Declaration
protected void OnHeaderTitleClick()

OnInitialized()

Declaration
protected override void OnInitialized()

OnParametersSet()

Declaration
protected override void OnParametersSet()

Refresh()

Re-renders the component.

Declaration
public void Refresh()

SetParametersAsync(ParameterView)

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Microsoft.AspNetCore.Components.ParameterView parameters

Returns
System.Threading.Tasks.Task