ClassTelerikDateRangePicker<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:
Inherited Members
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
AllowCaretMode
Specifies if a caret can be displayed during input (when possible).
Declaration
[Parameter]
public bool AllowCaretMode { get; set; }
Property Value
AllowReverse
Defines if the end date can precede the start date.
Declaration
[Parameter]
public bool AllowReverse { get; set; }
Property Value
AriaLabel
Describe the aria-label attribute for the component.
Declaration
[Parameter]
public string AriaLabel { get; set; }
Property Value
AutoCorrectParts
Specifies if date parts will be auto corrected.
Declaration
[Parameter]
public bool AutoCorrectParts { get; set; }
Property Value
AutoSwitchKeys
Specifies which keys should switch date parts.
AutoSwitchParts
Specifies if date parts will be automatically switched when completed.
Declaration
[Parameter]
public bool AutoSwitchParts { get; set; }
Property Value
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
ChildContent
Declaration
[Parameter]
public RenderFragment ChildContent { get; set; }
Property Value
DebounceDelay
Time in ms between the last typed symbol and the updating of the value. Default is 150ms.
DisabledDates
Specifies a list of dates that can not be selected.
Enabled
Specifies whether the DateRangePicker is enabled.
EndId
Specifies the id of the end date input.
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
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
Format
Specifies the format of the date inputs of the DateRangePicker.
HeaderTemplate
Specifies the header template.
Declaration
[Parameter]
public RenderFragment HeaderTemplate { get; set; }
Property Value
Max
Sets the maximum allowed date of the DateRangePicker.
Min
Sets the minimum allowed date of the DateRangePicker.
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
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
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
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
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
Placeholder
Specifies the placeholder attribute of the component.
Declaration
[Parameter]
public string Placeholder { get; set; }
Property Value
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
ReadOnly
The parameter is used to specify if the input field should be read-only.
When set to true
, the input becomes non-editable.
ShowClearButton
Specifies if the clear button will be displayed.
Declaration
[Parameter]
public bool ShowClearButton { get; set; }
Property Value
ShowOtherMonthDays
Defines if the days from adjacent months are shown.
Declaration
[Parameter]
public bool ShowOtherMonthDays { get; set; }
Property Value
ShowWeekNumbers
Defines if additional week number column is added.
Declaration
[Parameter]
public bool ShowWeekNumbers { get; set; }
Property Value
StartId
Specifies the id of the start date input.
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
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
TabIndex
The TabIndex of the component.
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
View
Specifies the current CalendarView that will be displayed in the picker calendar.
Declaration
[Parameter]
public CalendarView View { get; set; }
Property Value
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
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
Overrides
Dispose()
Declaration
public override void Dispose()
Overrides
FocusEndAsync()
Moves focus to the end input.
FocusStartAsync()
Moves focus to the start input.
NavigateTo(DateTime, CalendarView)
Moves the calendar to specific date in a view.
Declaration
public void NavigateTo(DateTime date, CalendarView view)
Parameters
date
The date to which to navigate.
view
The view to which to navigate.