DatePickerBuilder
Defines the fluent API for configuring the Kendo UI DatePicker
Properties
WriteAction - Func
Methods
Animation(System.Boolean)
Use to enable or disable animation of the popup element.
Parameters
enable - System.Boolean
The boolean value.
Example
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Animation(false) //toggle effect
)
Animation(System.Action)
Configures the animation effects of the widget.
Parameters
animationAction - System.Action<PopupAnimationBuilder>
The action which configures the animation effects.
Example
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Animation(animation =>
{
animation.Open(open =>
{
open.SlideIn(SlideDirection.Down);
})
})
)
DisableDates(System.Collections.Generic.IEnumerable)
Parameters
disableDates - System.Collections.Generic.IEnumerable<String>
DisableDates(System.DayOfWeek[])
Specifies the disabled dates in the DatePicker widget.
Parameters
days - System.DayOfWeek[]
Configures the disabled dates.
Example
@(Html.Kendo().DatePicker()
.Name("datePicker")
.DisableDates(DayofWeek.Saturday, DayOfWeek.Sunday)
)
DisableDates(System.String)
Specifies the disabled dates in the DatePicker widget using a function handler.
Parameters
handler - System.String
Configures the disabled dates.
Example
@(Html.Kendo().DatePicker()
.Name("datePicker")
.DisableDates("disableDates")
)
Enable(System.Boolean)
Enables or disables the picker.
Parameters
value - System.Boolean
Example
@(Html.Kendo().DatePicker()
.Name("datePicker")
.Enable(false)
)
Value(System.String)
Sets the value of the picker input
Parameters
date - System.String
Example
@(Html.Kendo().DatePicker()
.Name("datePicker")
.Value("8/1/2022")
)
Value(System.Nullable)
Sets the value of the picker input
Parameters
date - System.Nullable<DateTime>
The initial value of the picker.
Example
@(Html.Kendo().DatePicker()
.Name("datePicker")
.Value(DateTime.Now)
)
BindTo(System.Collections.Generic.List)
Specifies a list of dates, which will be passed to the month template.
Parameters
dates - System.Collections.Generic.List<DateTime>
The dates.
Example
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.BindTo(new List<DateTime> { DateTime.Now })
)
FooterId(System.String)
FooterId to be used for rendering the footer of the Calendar.
Parameters
id - System.String
The footer template's id.
Example
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.FooterId("widgetFooterId")
)
Footer(System.Boolean)
Enables/disables footer of the calendar popup.
Parameters
footer - System.Boolean
If set to false, disables the footer.
Example
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Footer(false)
)
MonthTemplateId(System.String)
MonthTemplateId to be used for rendering the cells of the Calendar.
Parameters
id - System.String
The month template's id.
Example
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.MonthTemplateId("widgetMonthTemplateId")
)
MonthTemplate(System.String)
Templates for the cells rendered in the "month" view.
Parameters
content - System.String
The month template's content.
Example
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.MonthTemplate("#= data.value #")
)
Min(System.String)
Sets the minimal date, which can be selected in DatePicker.
Parameters
date - System.String
The minimal date of the picker.
Example
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Min("01/02/2010")
)
Max(System.String)
Sets the maximal date, which can be selected in DatePicker.
Parameters
date - System.String
The maximal date of the picker.
Example
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Max("01/02/2022")
)
ARIATemplate(System.String)
Specifies a template used to populate the value of the aria-label attribute of the currently focused cell of the calendar. The parameters available for the template are: current - The current focused date.; valueType - The focused item value type - month, year and etc. or text - A text representing the focused value..
Parameters
value - System.String
The value for ARIATemplate
ARIATemplateId(System.String)
Specifies a template used to populate the value of the aria-label attribute of the currently focused cell of the calendar. The parameters available for the template are: current - The current focused date.; valueType - The focused item value type - month, year and etc. or text - A text representing the focused value..
Parameters
templateId - System.String
The ID of the template element for ARIATemplate
ComponentType(System.String)
Specifies the component type of the widget. "classic" - Uses the standard rendering of the widget. or "modern" - Uses new rendering with a fresh and modern look and feel..
Parameters
value - System.String
The value for ComponentType
Culture(System.String)
Specifies the culture info used by the widget.
Parameters
value - System.String
The value for Culture
DateInput(System.Boolean)
Specifies if the DatePicker will use DateInput for editing value
Parameters
value - System.Boolean
The value for DateInput
DateInput()
Specifies if the DatePicker will use DateInput for editing value
Dates(System.DateTime[])
Specifies a list of dates, which will be passed to the month content.
Parameters
value - System.DateTime[]
The value for Dates
Footer(System.String)
The template which renders the footer of the calendar. If false, the footer will not be rendered.
Parameters
value - System.String
The value for Footer
Format(System.String)
Specifies the format, which is used to format the value of the DatePicker displayed in the input. The format also will be used to parse the input.For more information on date and time formats please refer to Date Formatting.
Parameters
value - System.String
The value for Format
Label(System.Action)
Adds a label before the datepicker. If the datepicker has no id attribute, a generated id will be assigned. The string and the function parameters are setting the inner HTML of the label.
Parameters
configurator - System.Action<DatePickerLabelSettingsBuilder>
The configurator for the label setting.
Max(System.DateTime)
Specifies the maximum date, which the calendar can show.
Parameters
value - System.DateTime
The value for Max
Messages(System.Action)
Allows localization of the strings that are used in the widget.
Parameters
configurator - System.Action<DatePickerMessagesSettingsBuilder>
The configurator for the messages setting.
Min(System.DateTime)
Specifies the minimum date that the calendar can show.
Parameters
value - System.DateTime
The value for Min
Popup(System.Action)
The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation.
Parameters
configurator - System.Action<DatePickerPopupSettingsBuilder>
The configurator for the popup setting.
WeekNumber(System.Boolean)
If set to true a week of the year will be shown on the left side of the calendar. It is possible to define a template in order to customize what will be displayed.
Parameters
value - System.Boolean
The value for WeekNumber
WeekNumber()
If set to true a week of the year will be shown on the left side of the calendar. It is possible to define a template in order to customize what will be displayed.
ParseFormats(System.String[])
Specifies a list of date formats used to parse the value set with value() method or by direct user input. If not set the value of the format will be used. Note that the format option is always used during parsing.
Parameters
value - System.String[]
The value for ParseFormats
Value(System.DateTime)
Specifies the selected date.
Parameters
value - System.DateTime
The value for Value
Start(Kendo.Mvc.UI.CalendarView)
Parameters
value - CalendarView
The value for Start
Depth(Kendo.Mvc.UI.CalendarView)
Specifies the navigation depth.
Parameters
value - CalendarView
The value for Depth
MonthTemplate(System.Action)
Parameters
configurator - System.Action<DatePickerMonthTemplateSettingsBuilder>
The configurator for the monthtemplate setting.
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
Rounded(Kendo.Mvc.UI.Rounded)
Sets a value controlling the border radius.
Parameters
value - Rounded
The value for Rounded
FillMode(Kendo.Mvc.UI.FillMode)
Sets a value controlling how the color is applied.
Parameters
value - FillMode
The value for FillMode
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<DatePickerEventBuilder>
The client events action.
Example
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Events(events => events
.Change("onChange")
)
)
ToComponent()
Returns the internal view component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
Render()
Renders the component in place.