Class TelerikDateRangePicker<T>

The class for the DateRangePicker component.

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

Syntax

public class TelerikDateRangePicker<T> : BaseComponent, IDisposable, IFormatPlaceholderContainer
Type Parameters
T

Constructors

TelerikDateRangePicker()

Declaration
public TelerikDateRangePicker()

Properties

AdaptiveMode

Defines if the component will adapt and automatically change its rendering based on the current screen size. Default value is None.

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

AllowCaretMode

Specifies if a caret can be displayed during input (when possible).

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

AllowReverse

Defines if the end date can precede the start date.

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

AriaLabel

Describe the aria-label attribute for the component.

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

AutoCorrectParts

Specifies if date parts will be auto corrected.

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

AutoSwitchKeys

Specifies which keys should switch date parts.

Declaration
public List<object> AutoSwitchKeys { get; set; }
Property Value
System.Collections.Generic.List<System.Object>

AutoSwitchParts

Specifies if date parts will be automatically switched when completed.

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

BottomView

Specifies the bottommost view in the picker calendar to which the user can navigate. Default value is Month.

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

ChildContent

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

DebounceDelay

Time in ms between the last typed symbol and the updating of the value. Default is 150ms.

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

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>

Enabled

Specifies whether the DateRangePicker is enabled.

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

EndId

Specifies the id of the end date input.

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

EndValue

Specifies the value of the end date input.

Declaration
public T EndValue { get; set; }
Property Value
T

EndValueChanged

Specifies the handler that's called when the end value changes. Used for two-way binding.

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

EndValueExpression

Specifies the model Expression for the End value.

Declaration
public Expression<Func<T>> EndValueExpression { get; set; }
Property Value
System.Linq.Expressions.Expression<System.Func<T>>

FillMode

Specifies the fill mode of the DateRangePicker. Default value is Solid.

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

Format

Specifies the format of the date inputs of the DateRangePicker.

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

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 DateRangePicker.

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

Min

Sets the minimum allowed date of the DateRangePicker.

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

OnCalendarCellRender

Fires each time a calendar cell renders. Use the event to add a custom CSS class to each calendar cell based on its value.

Declaration
public Action<DateRangePickerCalendarCellRenderEventArgs> OnCalendarCellRender { get; set; }
Property Value
System.Action<DateRangePickerCalendarCellRenderEventArgs>

OnChange

Specifies the callback that's called when the current value is committed (confirmed) by the user - either through the Enter key, or when the Component loses focus.

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

OnClose

Defines the OnClose Event which is fired before the popup of the DateRangePicker is closed.

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

OnOpen

Defines the OnOpen Event which is fired before the popup of the DateRangePicker is opened.

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

Orientation

Specifies the orientation of the picker calendar. The available vaues are Horizontal (default) and Vertical.

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

Placeholder

Specifies the placeholder attribute of the component.

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

PopupClass

Defines the CSS class that will be applied to the rendered popup of the component.

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

ReadOnly

The parameter is used to specify if the input field should be read-only. When set to true, the input becomes non-editable.

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

Rounded

Specifies the roundness of the DateRangePicker. Default value is Medium.

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

ShowClearButton

Specifies if the clear button will be displayed.

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

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 DateRangePicker. Default value is Medium.

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

StartId

Specifies the id of the start date input.

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

StartValue

Specifies the value of the start date input.

Declaration
public T StartValue { get; set; }
Property Value
T

StartValueChanged

Specifies the handler that's called when the start value changes. Used for two-way binding.

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

StartValueExpression

Specifies the model Expression for the Start value.

Declaration
public Expression<Func<T>> StartValueExpression { get; set; }
Property Value
System.Linq.Expressions.Expression<System.Func<T>>

Subtitle

Defines the subtitle text rendered in the header of the popup. Applicable only when Auto is set.

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

TabIndex

The TabIndex of the component.

Declaration
public Nullable<int> TabIndex { get; set; }
Property Value
System.Nullable<System.Int32>

Title

Defines the title text rendered in the header of the popup. Applicable only when Auto is set.

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

TwoDigitYearMax

Specifies the maximum year to assume to be from the current century when typing two-digit year value. The default value is 68, indicating that typing any value less than 69 will be assumed to be 20xx, while 69 and larger will be assumed to be 19xx.

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

View

Specifies the current CalendarView that will be displayed in the picker calendar.

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

ViewChanged

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

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

Methods

BuildRenderTree(RenderTreeBuilder)

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

Close()

Closes the component.

Declaration
public void Close()

Dispose()

Declaration
public override void Dispose()
Overrides

FocusEndAsync()

Moves focus to the end input.

Declaration
public Task FocusEndAsync()
Returns
System.Threading.Tasks.Task

FocusStartAsync()

Moves focus to the start input.

Declaration
public Task FocusStartAsync()
Returns
System.Threading.Tasks.Task

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

OnInitializedAsync()

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

Overrides

OnParametersSetAsync()

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

Open()

Opens the component.

Declaration
public void Open()

Refresh()

Re-renders the component.

Declaration
public void Refresh()