Back to all docs

Class
TelerikDateRangePicker<T>

The class for the DateRangePicker component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

T

Syntax:

public class TelerikDateRangePicker<T> : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikDateRangePicker<T>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()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>)ComponentBase.DisExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)

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

[Parameter]
public AdaptiveMode AdaptiveMode { get; set; }

Property Value

AdaptiveMode

AllowCaretMode

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

Declaration

[Parameter]
public bool AllowCaretMode { get; set; }

Property Value

bool

AllowReverse

Defines if the end date can precede the start date.

Declaration

[Parameter]
public bool AllowReverse { get; set; }

Property Value

bool

AriaLabel

Describe the aria-label attribute for the component.

Declaration

[Parameter]
public string AriaLabel { get; set; }

Property Value

string

AutoCorrectParts

Specifies if date parts will be auto corrected.

Declaration

[Parameter]
public bool AutoCorrectParts { get; set; }

Property Value

bool

AutoSwitchKeys

Specifies which keys should switch date parts.

Declaration

[Parameter]
public List<object> AutoSwitchKeys { get; set; }

Property Value

List<object>

AutoSwitchParts

Specifies if date parts will be automatically switched when completed.

Declaration

[Parameter]
public bool AutoSwitchParts { get; set; }

Property Value

bool

BottomView

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

Declaration

[Parameter]
public CalendarView BottomView { get; set; }

Property Value

CalendarView

ChildContent

Declaration

[Parameter]
public RenderFragment ChildContent { get; set; }

Property Value

RenderFragment

DebounceDelay

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

Declaration

[Parameter]
public int DebounceDelay { get; set; }

Property Value

int

DisabledDates

Specifies a list of dates that can not be selected.

Declaration

[Parameter]
public List<DateTime> DisabledDates { get; set; }

Property Value

List<DateTime>

Enabled

Specifies whether the DateRangePicker is enabled.

Declaration

[Parameter]
public bool Enabled { get; set; }

Property Value

bool

EndId

Specifies the id of the end date input.

Declaration

[Parameter]
public string EndId { get; set; }

Property Value

string

EndValue

Specifies the value of the end date input.

Declaration

[Parameter]
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

[Parameter]
public EventCallback<T> EndValueChanged { get; set; }

Property Value

EventCallback<T>

EndValueExpression

Specifies the model Expression for the End value.

Declaration

[Parameter]
public Expression<Func<T>> EndValueExpression { get; set; }

Property Value

Expression<Func<T>>

FillMode

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

Declaration

[Parameter]
public string FillMode { get; set; }

Property Value

string

Format

Specifies the format of the date inputs of the DateRangePicker.

Declaration

[Parameter]
public string Format { get; set; }

Property Value

string

HeaderTemplate

Specifies the header template.

Declaration

[Parameter]
public RenderFragment HeaderTemplate { get; set; }

Property Value

RenderFragment

InputMode

Specifies the inputmode attribute of the underlying HTML input element.

Declaration

[Parameter]
public string InputMode { get; set; }

Property Value

string

Max

Sets the maximum allowed date of the DateRangePicker.

Declaration

[Parameter]
public DateTime Max { get; set; }

Property Value

DateTime

Min

Sets the minimum allowed date of the DateRangePicker.

Declaration

[Parameter]
public DateTime Min { get; set; }

Property Value

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

[Parameter]
public Action<DateRangePickerCalendarCellRenderEventArgs> OnCalendarCellRender { get; set; }

Property Value

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

[Parameter]
public EventCallback<DateRangePickerChangeEventArgs> OnChange { get; set; }

Property Value

EventCallback<DateRangePickerChangeEventArgs>

OnClose

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

Declaration

[Parameter]
public EventCallback<DateRangePickerCloseEventArgs> OnClose { get; set; }

Property Value

EventCallback<DateRangePickerCloseEventArgs>

OnOpen

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

Declaration

[Parameter]
public EventCallback<DateRangePickerOpenEventArgs> OnOpen { get; set; }

Property Value

EventCallback<DateRangePickerOpenEventArgs>

Orientation

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

Declaration

[Parameter]
public CalendarOrientation Orientation { get; set; }

Property Value

CalendarOrientation

Placeholder

Specifies the placeholder attribute of the component.

Declaration

[Parameter]
public string Placeholder { get; set; }

Property Value

string

PopupClass

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

Declaration

[Parameter]
public string PopupClass { get; set; }

Property Value

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

[Parameter]
public bool ReadOnly { get; set; }

Property Value

bool

Rounded

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

Declaration

[Parameter]
public string Rounded { get; set; }

Property Value

string

ShowClearButton

Specifies if the clear button will be displayed.

Declaration

[Parameter]
public bool ShowClearButton { get; set; }

Property Value

bool

ShowOtherMonthDays

Defines if the days from adjacent months are shown.

Declaration

[Parameter]
public bool ShowOtherMonthDays { get; set; }

Property Value

bool

ShowWeekNumbers

Defines if additional week number column is added.

Declaration

[Parameter]
public bool ShowWeekNumbers { get; set; }

Property Value

bool

Size

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

Declaration

[Parameter]
public string Size { get; set; }

Property Value

string

StartId

Specifies the id of the start date input.

Declaration

[Parameter]
public string StartId { get; set; }

Property Value

string

StartValue

Specifies the value of the start date input.

Declaration

[Parameter]
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

[Parameter]
public EventCallback<T> StartValueChanged { get; set; }

Property Value

EventCallback<T>

StartValueExpression

Specifies the model Expression for the Start value.

Declaration

[Parameter]
public Expression<Func<T>> StartValueExpression { get; set; }

Property Value

Expression<Func<T>>

Subtitle

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

Declaration

[Parameter]
public string Subtitle { get; set; }

Property Value

string

TabIndex

The TabIndex of the component.

Declaration

[Parameter]
public int? TabIndex { get; set; }

Property Value

int?

Title

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

Declaration

[Parameter]
public string Title { get; set; }

Property Value

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

[Parameter]
public int TwoDigitYearMax { get; set; }

Property Value

int

View

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

Declaration

[Parameter]
public CalendarView View { get; set; }

Property Value

CalendarView

ViewChanged

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

Declaration

[Parameter]
public EventCallback<CalendarView> ViewChanged { get; set; }

Property Value

EventCallback<CalendarView>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Close()

Closes the component.

Declaration

public void Close()

Dispose()

Declaration

public override void Dispose()

Overrides BaseComponent.Dispose()

FocusEndAsync()

Moves focus to the end input.

Declaration

public Task FocusEndAsync()

Returns

Task

FocusStartAsync()

Moves focus to the start input.

Declaration

public Task FocusStartAsync()

Returns

Task

NavigateTo(DateTime, CalendarView)

Moves the calendar to specific date in a view.

Declaration

public void NavigateTo(DateTime date, CalendarView view)

Parameters

date

DateTime

The date to which to navigate.

view

CalendarView

The view to which to navigate.

OnAfterRenderAsync(bool)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Task

Overrides BaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Task

Overrides ComponentBase.OnParametersSetAsync()

Open()

Opens the component.

Declaration

public void Open()

Refresh()

Re-renders the component.

Declaration

public void Refresh()
DefinitionConstructorsTelerikDateRangePicker()PropertiesAllowCaretModeAllowReverseAriaLabelAutoCorrectPartsAutoSwitchKeysAutoSwitchPartsBottomViewChildContentDebounceDelayDisabledDatesEnabledEndIdEndValueEndValueChangedEndValueExpressionFillModeFormatInputModeMaxMinOnCalendarCellRenderOnChangeOnCloseOnOpenOrientationPlaceholderRoundedShowClearButtonShowOtherMonthDaysShowWeekNumbersSizeStartIdStartValueStartValueChangedStartValueExpressionSubtitleTabIndexTitleTwoDigitYearMaxViewViewChangedMethodsBuildRenderTree(RenderTreeBuilder)Close()Dispose()FocusEndAsync()FocusStartAsync()NavigateTo(DateTime, CalendarView)OnAfterRenderAsync(bool)OnInitializedAsync()OnParametersSetAsync()Open()Refresh()
Not finding the help you need?
Contact Support