Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / DatePickerBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

DatePickerBuilder

Class

Defines the fluent interface for configuring the DatePicker component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class DatePickerBuilder : DatePickerBuilderBase<DatePicker, DatePickerBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<DatePicker, DatePickerBuilder>DatePickerBuilderBase<DatePicker, DatePickerBuilder>DatePickerBuilder

Implements: IHtmlString

Inherited Members DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Animation(bool)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Animation(Action<PopupAnimationBuilder>)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.AutoAdjust(bool)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Culture(string)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Events(Action<DatePickerEventBuilderBase>)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Format(string)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.ParseFormats(IEnumerable<string>)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Enable(bool)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Min(DateTime)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Max(DateTime)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Value(DateTime?)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Value(string)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.DateInput(bool)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.DateInput()DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Popup(Action<PopupSettingsBuilder>)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Messages(Action<DatePickerBaseMessagesSettingsBuilder>)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.Label(Action<LabelSettingsBuilder>)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.AdaptiveMode(AdaptiveMode)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.AdaptiveTitle(string)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.AdaptiveSubtitle(string)DatePickerBuilderBase<DatePicker, DatePickerBuilder>.AutoCorrectParts(bool)WidgetBuilderBase<DatePicker, DatePickerBuilder>.ToComponent()WidgetBuilderBase<DatePicker, DatePickerBuilder>.Name(string)WidgetBuilderBase<DatePicker, DatePickerBuilder>.Deferred(bool)WidgetBuilderBase<DatePicker, DatePickerBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<DatePicker, DatePickerBuilder>.HtmlAttributes(object)WidgetBuilderBase<DatePicker, DatePickerBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<DatePicker, DatePickerBuilder>.AsModule(bool)WidgetBuilderBase<DatePicker, DatePickerBuilder>.Render()WidgetBuilderBase<DatePicker, DatePickerBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<DatePicker, DatePickerBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<DatePicker, DatePickerBuilder>.ToHtmlString()WidgetBuilderBase<DatePicker, DatePickerBuilder>.ToClientTemplate()WidgetBuilderBase<DatePicker, DatePickerBuilder>.ToString()WidgetBuilderBase<DatePicker, DatePickerBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

DatePickerBuilder(DatePicker)

Initializes a new instance of the DatePickerBuilder class.

C#
public DatePickerBuilder(DatePicker component)
Parameters:componentDatePicker

The component.

Methods

ARIATemplate(string)

Specifies a template used to populate aria-label attribute.

C#
public DatePickerBuilder ARIATemplate(string template)
Parameters:templatestring

The string template.

Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.ARIATemplate("Date: #=kendo.toString(data.current, 'd')#")
)

AutoFill()

When enabled, the DatePicker will autofill the rest of the date to the current date when the component looses focus. For example, entering only the date, month or year portion of the date and blurring the component, the missing sections will be automatically completed. Requires a DateInput for editing the value.

C#
public DatePickerBuilder AutoFill()
Returns:

DatePickerBuilder

AutoFill(bool)

When enabled, the DatePicker will autofill the rest of the date to the current date when the component looses focus. For example, entering only the date, month or year portion of the date and blurring the component, the missing sections will be automatically completed. Requires a DateInput for editing the value.

C#
public DatePickerBuilder AutoFill(bool value)
Parameters:valuebool

The value for AutoFill

Returns:

DatePickerBuilder

BindTo(List<DateTime>)

Specifies a list of dates, which will be passed to the month template.

C#
public DatePickerBuilder BindTo(List<DateTime> dates)
Parameters:datesList<DateTime>

The dates.

Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.BindTo(new List&lt;DateTime&gt; { DateTime.Now })
)

ComponentType(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..

C#
public DatePickerBuilder ComponentType(string value)
Parameters:valuestring

The value for ComponentType

Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.ComponentType("modern")
)

Depth(CalendarView)

Specifies the navigation depth.

C#
public DatePickerBuilder Depth(CalendarView depth)
Parameters:depthCalendarViewReturns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Depth(CalendarView.Month)
)

DisableDates(params DayOfWeek[])

Specifies the disabled dates in the DatePicker widget.

C#
public DatePickerBuilder DisableDates(params DayOfWeek[] days)
Parameters:daysDayOfWeek[]Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("datePicker")
.DisableDates(DayofWeek.Saturday, DayOfWeek.Sunday)
)

DisableDates(string)

Specifies the disabled dates handler in the DatePicker widget using a function.

C#
public DatePickerBuilder DisableDates(string handler)
Parameters:handlerstringReturns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.DisableDates("disableDates")
)

FillMode(FillMode)

Sets a value controlling how the color is applied.

C#
public DatePickerBuilder FillMode(FillMode value)
Parameters:valueFillMode

The value for FillMode

Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.FillMode(FillMode.Outline)
)

Footer(bool)

Enables/disables footer of the calendar popup.

C#
public DatePickerBuilder Footer(bool footer)
Parameters:footerboolReturns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Footer(false)
)

Footer(string)

Footer template to be used for rendering the footer of the Calendar.

C#
public DatePickerBuilder Footer(string footer)
Parameters:footerstringReturns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Footer("#= kendo.toString(data, "G") #")
)

FooterId(string)

FooterId to be used for rendering the footer of the Calendar.

C#
public DatePickerBuilder FooterId(string id)
Parameters:idstringReturns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.FooterId("widgetFooterId")
)

InputMode(string)

Defines the "inputmode" attribute of the inner <input /> element. The attribute specifies the type of on-screen keyboard displayed when the user focuses the input.

C#
public DatePickerBuilder InputMode(string value)
Parameters:valuestring

The value that configures the "inputmode" attribute.

Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("datePicker")
.InputMode("numeric")
)

Max(string)

Sets the maximal date, which can be selected in DatePicker.

C#
public DatePickerBuilder Max(string date)
Parameters:datestring

The maximal date of the picker.

Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Max("01/02/2022")
)

Min(string)

Sets the minimal date, which can be selected in DatePicker.

C#
public DatePickerBuilder Min(string date)
Parameters:datestring

The minimal date of the picker.

Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Min("01/02/2010")
)

MonthTemplate(Action<MonthTemplateBuilder>)

Configures the content of cells of the Calendar.

C#
public DatePickerBuilder MonthTemplate(Action<MonthTemplateBuilder> monthTemplateAction)
Parameters:monthTemplateActionAction<MonthTemplateBuilder>Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.MonthTemplate(month =&gt; month.Content("#= data.value #"))
)

MonthTemplate(string)

Templates for the cells rendered in the "month" view.

C#
public DatePickerBuilder MonthTemplate(string content)
Parameters:contentstringReturns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.MonthTemplate("#= data.value #")
)

MonthTemplateHandler(string)

The JavaScript function that returns the MonthTemplate to be used for rendering the cells of the Calendar.

C#
public DatePickerBuilder MonthTemplateHandler(string value)
Parameters:valuestringReturns:

DatePickerBuilder

MonthTemplateId(string)

MonthTemplateId to be used for rendering the cells of the Calendar.

C#
public DatePickerBuilder MonthTemplateId(string id)
Parameters:idstringReturns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.MonthTemplateId("widgetMonthTemplateId")
)

MonthTemplateView(MvcHtmlString)

MonthTemplateView to be used for rendering the cells of the Calendar.

C#
public DatePickerBuilder MonthTemplateView(MvcHtmlString template)
Parameters:templateMvcHtmlStringReturns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.MonthTemplateView(Html.Partial("MonthTemplateView"))
)

Readonly()

If set to true, the widget will be readonly and will not allow user input. The widget is not readonly be default and allow user input.

C#
public DatePickerBuilder Readonly()
Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("datePicker")
.Readonly()
)

Readonly(bool)

If set to true, the widget will be readonly and will not allow user input. The widget is not readonly be default and allow user input.

C#
public DatePickerBuilder Readonly(bool value)
Parameters:valuebool

The value for Readonly

Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("datePicker")
.Readonly(true)
)

Rounded(Rounded?)

Sets a value controlling the border radius.

C#
public DatePickerBuilder Rounded(Rounded? value)
Parameters:valueRounded?

The value for Rounded

Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Rounded(Rounded.Medium)
)

Size(ComponentSize?)

Sets the size of the component.

C#
public DatePickerBuilder Size(ComponentSize? value)
Parameters:valueComponentSize?

The value for Size

Returns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Size(ComponentSize.Medium)
)

Start(CalendarView)

Specifies the start view.

C#
public DatePickerBuilder Start(CalendarView start)
Parameters:startCalendarViewReturns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.Start(CalendarView.Month)
)

WeekNumber(bool)

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.

C#
public DatePickerBuilder WeekNumber(bool weekNumber)
Parameters:weekNumberboolReturns:

DatePickerBuilder

Example:
C#
@(Html.Kendo().DatePicker()
.Name("DatePicker")
.WeekNumber(true)
)
In this article
DefinitionConstructorsDatePickerBuilder(DatePicker)MethodsARIATemplate(string)AutoFill()AutoFill(bool)BindTo(List<DateTime>)ComponentType(string)Depth(CalendarView)DisableDates(params DayOfWeek[])DisableDates(string)FillMode(FillMode)Footer(bool)Footer(string)FooterId(string)InputMode(string)Max(string)Min(string)MonthTemplate(Action<MonthTemplateBuilder>)MonthTemplate(string)MonthTemplateHandler(string)MonthTemplateId(string)MonthTemplateView(MvcHtmlString)Readonly()Readonly(bool)Rounded(Rounded?)Size(ComponentSize?)Start(CalendarView)WeekNumber(bool)
Not finding the help you need?
Contact Support