RadzenDatePicker<TValue> Class

RadzenDatePicker<TValue>linkLink to this section

A date and time picker component that provides a calendar popup for selecting dates and optional time selection. RadzenDatePicker supports DateTime, DateTime?, DateTimeOffset, DateTimeOffset?, DateOnly, and DateOnly? types with extensive customization options. Displays a text input with a calendar icon button. Clicking opens a popup calendar for date selection. Optional time selection can be enabled via ShowTime property, supporting both 12-hour and 24-hour formats. Supports features like min/max date constraints, disabled dates, initial view configuration, calendar week display, inline calendar mode (always visible), time-only mode, multiple date selection, and culture-specific formatting.

Declaration

public RadzenDatePicker<TValue>()

inputlinkLink to this section

Gets input reference.

Declaration

protected ElementReference input

AllowClearlinkLink to this section

Gets or sets a value indicating whether value can be cleared.

Declaration

public bool AllowClear { get; set; }

Property Value

AllowInputlinkLink to this section

Gets or sets a value indicating whether input is allowed.

Declaration

public bool AllowInput { get; set; }

Property Value

ButtonClasslinkLink to this section

Gets or sets the button CSS class.

Declaration

public string ButtonClass { get; set; }

Property Value

CalendarWeekTitlelinkLink to this section

Gets or sets the previous month aria label text.

Declaration

public string CalendarWeekTitle { get; set; }

Property Value

ChangelinkLink to this section

Gets or sets the change callback.

Declaration

public EventCallback<DateTime?> Change { get; set; }

Property Value

ClearAriaLabellinkLink to this section

Gets or sets the clear button aria label text.

Declaration

public string ClearAriaLabel { get; set; }

Property Value

CurrentDateChangedlinkLink to this section

Gets or set the current date changed callback.

Declaration

public EventCallback<DateTime> CurrentDateChanged { get; set; }

Property Value

CurrentPlaceholderlinkLink to this section

Gets the current placeholder. Returns empty string if this component is inside a RadzenFormField.

Declaration

protected string CurrentPlaceholder { get; }

Property Value

DateFormatlinkLink to this section

Gets or sets the date format.

Declaration

public string DateFormat { get; set; }

Property Value

DateRenderlinkLink to this section

Gets or sets the date render callback. Use it to set attributes.

Declaration

public Action<DateRenderEventArgs> DateRender { get; set; }

Property Value

DisabledlinkLink to this section

Gets or sets a value indicating whether this RadzenDatePicker<T> is disabled.

Declaration

public bool Disabled { get; set; }

Property Value

DisabledAriaLabellinkLink to this section

Gets or sets the suffix appended to a day cell's aria label when the date is disabled.

Declaration

public string DisabledAriaLabel { get; set; }

Property Value

EditContextlinkLink to this section

Gets or sets the edit context.

Declaration

public Forms.EditContext EditContext { get; set; }

Property Value

FieldIdentifierlinkLink to this section

Gets the field identifier.

Declaration

public Forms.FieldIdentifier FieldIdentifier { get; set; }

Property Value

FooterTemplatelinkLink to this section

Gets or sets the footer template.

Declaration

public RenderFragment FooterTemplate { get; set; }

Property Value

FormlinkLink to this section

Gets or sets the form.

Declaration

public IRadzenForm Form { get; set; }

Property Value

FormFieldContextlinkLink to this section

Gets or sets the FormFieldContext of the component

Declaration

public IFormFieldContext FormFieldContext { get; set; }

Property Value

FormattedValuelinkLink to this section

Gets the formatted value.

Declaration

public string FormattedValue { get; }

Property Value

HasValuelinkLink to this section

Gets a value indicating whether this instance has value.

Declaration

public bool HasValue { get; }

Property Value

HourAriaLabellinkLink to this section

Gets or sets the hour input aria label text.

Declaration

public string HourAriaLabel { get; set; }

Property Value

HourFormatlinkLink to this section

Gets or sets the hour format.

Declaration

public string HourFormat { get; set; }

Property Value

HoursSteplinkLink to this section

Gets or sets the hours step.

Declaration

public string HoursStep { get; set; }

Property Value

ImmediatelinkLink to this section

Gets or sets a value indicating whether the component should update its value on every input event rather than waiting for the input to lose focus (onchange event). When enabled, the bound value is updated as the user types, provided the input can be parsed as a valid date. Invalid intermediate input is ignored to avoid clearing the value while the user is still typing.

Declaration

public bool Immediate { get; set; }

Property Value

InitialViewDatelinkLink to this section

Gets or sets the Initial Date/Month View.

Declaration

public DateTime? InitialViewDate { get; set; }

Property Value

InlinelinkLink to this section

Gets or sets a value indicating whether this RadzenDatePicker<T> is inline - only Calender.

Declaration

public bool Inline { get; set; }

Property Value

InputAttributeslinkLink to this section

Specifies additional custom attributes that will be rendered by the input.

Declaration

public IReadOnlyDictionary<string, object> InputAttributes { get; set; }

Property Value

InputClasslinkLink to this section

Gets or sets the input CSS class.

Declaration

public string InputClass { get; set; }

Property Value

InputSizelinkLink to this section

Gets or sets the size of the component.

Declaration

public InputSize InputSize { get; set; }

Property Value

IsBoundlinkLink to this section

Gets a value indicating whether this instance is bound (ValueChanged callback has delegate).

Declaration

public bool IsBound { get; }

Property Value

KindlinkLink to this section

Gets or sets the kind of DateTime bind to control

Declaration

public DateTimeKind Kind { get; set; }

Property Value

MaxlinkLink to this section

Gets or sets the Maximum Selectable Date.

Declaration

public DateTime? Max { get; set; }

Property Value

MinlinkLink to this section

Gets or sets the Minimum Selectable Date.

Declaration

public DateTime? Min { get; set; }

Property Value

MinutesAriaLabellinkLink to this section

Gets or sets the minutes input aria label text.

Declaration

public string MinutesAriaLabel { get; set; }

Property Value

MinutesSteplinkLink to this section

Gets or sets the minutes step.

Declaration

public string MinutesStep { get; set; }

Property Value

MultiplelinkLink to this section

Gets or sets whether multiple dates can be selected. When enabled, users can select multiple dates from the calendar, and the value will be a collection of DateTimes.

Declaration

public bool Multiple { get; set; }

Property Value

NamelinkLink to this section

Gets or sets the name of the form component.

Declaration

public string Name { get; set; }

Property Value

NextMonthAriaLabellinkLink to this section

Gets or sets the next month aria label text.

Declaration

public string NextMonthAriaLabel { get; set; }

Property Value

OkAriaLabellinkLink to this section

Gets or sets the OK button aria label text.

Declaration

public string OkAriaLabel { get; set; }

Property Value

OkClicklinkLink to this section

Gets or sets the OK click callback. Fires only when the user clicks the OK button (visible when ShowTimeOkButton is true), allowing developers to distinguish between intermediate day-selection changes and the final user confirmation.

Declaration

public EventCallback<DateTime?> OkClick { get; set; }

Property Value

PadHourslinkLink to this section

Gets or sets a value indicating whether the hour picker is padded with a leading zero.

Declaration

public bool PadHours { get; set; }

Property Value

PadMinuteslinkLink to this section

Gets or sets a value indicating whether the minute picker is padded with a leading zero.

Declaration

public bool PadMinutes { get; set; }

Property Value

PadSecondslinkLink to this section

Gets or sets a value indicating whether the second picker is padded with a leading zero.

Declaration

public bool PadSeconds { get; set; }

Property Value

ParseInputlinkLink to this section

Parse the input using an function outside the Radzen-library

Declaration

public Func<string, DateTime?> ParseInput { get; set; }

Property Value

PlaceholderlinkLink to this section

Gets or sets the input placeholder.

Declaration

public string Placeholder { get; set; }

Property Value

PopupAriaLabellinkLink to this section

Gets or sets the popup aria label text.

Declaration

public string PopupAriaLabel { get; set; }

Property Value

PopupRenderModelinkLink to this section

Gets or sets the render mode.

Declaration

public PopupRenderMode PopupRenderMode { get; set; }

Property Value

PrevMonthAriaLabellinkLink to this section

Gets or sets the previous month aria label text.

Declaration

public string PrevMonthAriaLabel { get; set; }

Property Value

ReadOnlylinkLink to this section

Gets or sets a value indicating whether read only.

Declaration

public bool ReadOnly { get; set; }

Property Value

SecondsAriaLabellinkLink to this section

Gets or sets the seconds input aria label text.

Declaration

public string SecondsAriaLabel { get; set; }

Property Value

SecondsSteplinkLink to this section

Gets or sets the seconds step.

Declaration

public string SecondsStep { get; set; }

Property Value

SelectedAriaLabellinkLink to this section

Gets or sets the suffix appended to a day cell's aria label when the date is selected.

Declaration

public string SelectedAriaLabel { get; set; }

Property Value

ShowButtonlinkLink to this section

Gets or sets a value indicating whether popup datepicker button is shown.

Declaration

public bool ShowButton { get; set; }

Property Value

ShowCalendarWeeklinkLink to this section

Gets or sets whether the calendar week number column should be displayed in the calendar popup. When enabled, each week row shows its corresponding week number according to ISO 8601.

Declaration

public bool ShowCalendarWeek { get; set; }

Property Value

ShowDayslinkLink to this section

Gets or sets a value indicating whether days part is shown.

Declaration

public bool ShowDays { get; set; }

Property Value

ShowHourlinkLink to this section

Gets or sets a value indicating whether hour is shown.

Declaration

public bool ShowHour { get; set; }

Property Value

ShowInputlinkLink to this section

Gets or sets a value indicating whether the input box is shown. Ignored if ShowButton is false.

Declaration

public bool ShowInput { get; set; }

Property Value

ShowMinuteslinkLink to this section

Gets or sets a value indicating whether minutes are shown.

Declaration

public bool ShowMinutes { get; set; }

Property Value

ShowSecondslinkLink to this section

Gets or sets a value indicating whether seconds are shown.

Declaration

public bool ShowSeconds { get; set; }

Property Value

ShowTimelinkLink to this section

Gets or sets a value indicating whether time part is shown.

Declaration

public bool ShowTime { get; set; }

Property Value

ShowTimeOkButtonlinkLink to this section

Gets or sets a value indicating whether time ok button is shown.

Declaration

public bool ShowTimeOkButton { get; set; }

Property Value

TabIndexlinkLink to this section

Gets or sets the tab index.

Declaration

public int TabIndex { get; set; }

Property Value

TimeOnlylinkLink to this section

Gets or sets a value indicating whether time only can be set.

Declaration

public bool TimeOnly { get; set; }

Property Value

TodayAriaLabellinkLink to this section

Gets or sets the suffix appended to a day cell's aria label when the date is today.

Declaration

public string TodayAriaLabel { get; set; }

Property Value

ToggleAmPmAriaLabellinkLink to this section

Gets or sets the toggle Am/Pm aria label text.

Declaration

public string ToggleAmPmAriaLabel { get; set; }

Property Value

ToggleAriaLabellinkLink to this section

Gets or sets the toggle popup aria label text.

Declaration

public string ToggleAriaLabel { get; set; }

Property Value

ValuelinkLink to this section

Gets or sets the value.

Declaration

public object Value { get; set; }

Property Value

ValueChangedlinkLink to this section

Gets or sets the value changed callback.

Declaration

public EventCallback<TValue> ValueChanged { get; set; }

Property Value

ValueExpressionlinkLink to this section

Gets or sets the value expression.

Declaration

public Expressions.Expression<Func<TValue>> ValueExpression { get; set; }

Property Value

YearFormatlinkLink to this section

Gets ot sets the year format. Set to yyyy by default.

Declaration

public string YearFormat { get; set; }

Property Value

YearFormatterlinkLink to this section

Gets or sets the year formatter. Set to FormatYear by default. If set, this function will take precedence over YearFormat.

Declaration

public Func<int, string> YearFormatter { get; set; }

Property Value

YearRangelinkLink to this section

Gets or sets the year range.

Declaration

public string YearRange { get; set; }

Property Value

BuildRenderTreelinkLink to this section

Declaration

protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)

Parameters

CloselinkLink to this section

Closes this instance popup.

Declaration

public void Close()

DisposelinkLink to this section

Declaration

public override void Dispose()

FocusAsynclinkLink to this section

Declaration

public ValueTask FocusAsync()

Returns

GetComponentCssClasslinkLink to this section

Declaration

protected override string GetComponentCssClass()

Returns

GetValuelinkLink to this section

Gets the value.

Declaration

public object GetValue()

Returns

OnAfterRenderAsynclinkLink to this section

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

OnInitializedlinkLink to this section

Declaration

protected override void OnInitialized()

OnPopupCloselinkLink to this section

Called from JavaScript when the popup is closed (e.g. by clicking outside) in Initial render mode.

Declaration

public void OnPopupClose()

ParseDatelinkLink to this section

Parses the date.

Declaration

protected Task ParseDate()

Returns

ParseDateImmediatelinkLink to this section

Parses the date on input. Ignores invalid intermediate input to avoid clearing the value while the user is typing.

Declaration

protected Task ParseDateImmediate()

Returns

SetParametersAsynclinkLink to this section

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Returns