New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

DateTimePickerBuilder

Class

Defines the fluent interface for configuring the TimePicker component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class DateTimePickerBuilder : DatePickerBuilderBase<DateTimePicker, DateTimePickerBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<DateTimePicker, DateTimePickerBuilder>DatePickerBuilderBase<DateTimePicker, DateTimePickerBuilder>DateTimePickerBuilder

Implements: IHtmlString

Constructors

DateTimePickerBuilder(DateTimePicker)

Initializes a new instance of the TimePickerBuilder class.

public DateTimePickerBuilder(DateTimePicker component)

Parameters:componentDateTimePicker

The component.

Methods

ARIATemplate(string)

Specifies a template used to populate aria-label attribute.

public DateTimePickerBuilder ARIATemplate(string template)

Parameters:templatestring

The string template.

Returns:

DateTimePickerBuilder

Example:

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

BindTo(IList<DateTime>)

Binds the TimeView to a list of DateTime objects.

public DateTimePickerBuilder BindTo(IList<DateTime> dates)

Parameters:datesIList<DateTime>

The dates.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("TimePicker")
.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..

public DateTimePickerBuilder ComponentType(string value)

Parameters:valuestring

The value for ComponentType

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.ComponentType("classic")
)

Depth(CalendarView)

Specifies the navigation depth.

public DateTimePickerBuilder Depth(CalendarView depth)

Parameters:depthCalendarView

The value that will specify the navigation depth.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.Depth(CalendarView.Month)
)

DisableDates(params DayOfWeek[])

Specifies the disabled dates in the DateTimePicker widget.

public DateTimePickerBuilder DisableDates(params DayOfWeek[] days)

Parameters:daysDayOfWeek[]

The days that will be disabled in the Calendar.

Returns:

DateTimePickerBuilder

Example:

@(Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.DisableDates(DayofWeek.Saturday, DayOfWeek.Sunday)
)

DisableDates(string)

Specifies the disabled dates in the DateTimePicker widget using a function.

public DateTimePickerBuilder DisableDates(string handler)

Parameters:handlerstring

The JavaScript funcation that will be used to define the disabled cells in the Calendar.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.DisableDates("disableDates")
)

EndTime(DateTime)

If set, specifies the latest time the TimeView can show.

public DateTimePickerBuilder EndTime(DateTime date)

Parameters:dateDateTime

The value for StartTime

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.EndTime(new DateTime(2023,3,3,8,30,00))
)

EndTime(string)

If set, specifies the latest time the TimeView can show.

public DateTimePickerBuilder EndTime(string date)

Parameters:datestring

The value for StartTime

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.EndTime(new DateTime(2023,3,3,8,30,00).ToString())
)

FillMode(FillMode)

Sets a value controlling how the color is applied.

public DateTimePickerBuilder FillMode(FillMode value)

Parameters:valueFillMode

The value for FillMode

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.FillMode(FillMode.Outline)
)

Footer(bool)

Enables/disables footer of the calendar popup.

public DateTimePickerBuilder Footer(bool footer)

Parameters:footerbool

The value that displays or hides the footer of the Calendar.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.Footer(false)
)

Footer(string)

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

public DateTimePickerBuilder Footer(string footer)

Parameters:footerstring

The value that configures the content of the footer for the Calendar.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.Footer("#= kendo.toString(data, "G") #")
)

FooterId(string)

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

public DateTimePickerBuilder FooterId(string id)

Parameters:idstring

The id value that will be used for rendering the footer of the Calendar.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.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.

public DateTimePickerBuilder InputMode(string value)

Parameters:valuestring

The value that configures the "inputmode" attribute.

Returns:

DateTimePickerBuilder

Example:

@(Html.Kendo().DateTimePicker()
.Name("dtp")
.InputMode("numeric")
)

Interval(Action<IntervalSettingsBuilder>)

Specifies the interval between values in the popup list. When the componentType is set to modern, the interval is specified as an object of hours, minutes and seconds.

public DateTimePickerBuilder Interval(Action<IntervalSettingsBuilder> action)

Parameters:actionAction<IntervalSettingsBuilder>

The interval settings.

Returns:

DateTimePickerBuilder

Example:

@(Html.Kendo().DateTimePicker()
.Name("dateTimePicker")
.ComponentType("modern")
.Interval(interval =&gt; interval
.Hour(3);
.Minute(20);
.Second(15);
)
)

Interval(int)

Sets the interval between hours.

public DateTimePickerBuilder Interval(int interval)

Parameters:intervalint

The interval between hours.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("dateTimePicker")
.Interval(2)
)

Max(string)

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

public DateTimePickerBuilder Max(string date)

Parameters:datestring

The date value that will set the maximum value for selection.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("dateTimePicker")
.Max(DateTime.Today)
)

Min(string)

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

public DateTimePickerBuilder Min(string date)

Parameters:datestring

The date value that will set the minimal value for selection.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("dateTimePicker")
.Min(DateTime.Today)
)

MonthTemplate(Action<MonthTemplateBuilder>)

Configures the content of cells of the Calendar.

public DateTimePickerBuilder MonthTemplate(Action<MonthTemplateBuilder> monthTemplateAction)

Parameters:monthTemplateActionAction<MonthTemplateBuilder>

The action method that will be used for rendering cells the Calendar.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.MonthTemplate(month =&gt; month.Content("#= data.value #"))
)

MonthTemplate(string)

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

public DateTimePickerBuilder MonthTemplate(string content)

Parameters:contentstring

The content that will be used for rendering cells the Calendar.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.MonthTemplate("#= data.value #")
)

MonthTemplate<TModel>(TemplateBuilder<TModel>)

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

public DateTimePickerBuilder MonthTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.MonthTemplate(Html.Kendo().Template()
.AddHtml("&lt;div&gt;${data.value} &lt;/div&gt;")
)
)

MonthTemplateHandler(string)

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

public DateTimePickerBuilder MonthTemplateHandler(string template)

Parameters:templatestring

The JavaScript that will be used for rendering cells the Calendar.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.MonthTemplateHandler("handler")
)

MonthTemplateId(string)

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

public DateTimePickerBuilder MonthTemplateId(string id)

Parameters:idstring

The id value that will be used for rendering cells the Calendar.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.MonthTemplateId("widgetMonthTemplateId")
)

MonthTemplateView(MvcHtmlString)

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

public DateTimePickerBuilder MonthTemplateView(MvcHtmlString template)

Parameters:templateMvcHtmlString

The Razor View that will be used for rendering cells the Calendar.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.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.

public DateTimePickerBuilder Readonly()

Returns:

DateTimePickerBuilder

Example:

@(Html.Kendo().DateTimePicker()
.Name("dateTimePicker")
.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.

public DateTimePickerBuilder Readonly(bool value)

Parameters:valuebool

The value for Readonly

Returns:

DateTimePickerBuilder

Example:

@(Html.Kendo().DateTimePicker()
.Name("dateTimePicker")
.Readonly(true)
)

Rounded(Rounded?)

Sets a value controlling the border radius.

public DateTimePickerBuilder Rounded(Rounded? value)

Parameters:valueRounded?

The value for Rounded

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.Rounded(Rounded.Medium)
)

Size(ComponentSize?)

Sets the size of the component.

public DateTimePickerBuilder Size(ComponentSize? value)

Parameters:valueComponentSize?

The value for Size

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.Size(ComponentSize.Medium)
)

Start(CalendarView)

Specifies the start view.

public DateTimePickerBuilder Start(CalendarView start)

Parameters:startCalendarView

The value that will specify the start view.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.Start(CalendarView.Month)
)

StartTime(DateTime)

If set, specifies the earliset time the TimeView can show.

public DateTimePickerBuilder StartTime(DateTime date)

Parameters:dateDateTime

The value for StartTime

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.StartTime(new DateTime(2023,3,3,8,30,00))
)

StartTime(string)

If set, specifies the earliset time the TimeView can show.

public DateTimePickerBuilder StartTime(string date)

Parameters:datestring

The value for StartTime

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.StartTime(new DateTime(2023,3,3,8,30,00).ToString())
)

TimeFormat(string)

Specifies the format, which is used to format the values in the time drop-down list.

public DateTimePickerBuilder TimeFormat(string timeFormat)

Parameters:timeFormatstring

The value that will be used to format the predefined values in the time list.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("dateTimePicker")
.TimeFormat("hh:mm:ss tt")
)

WeekNumber(bool)

If set to true, a week numbers will be shown on the Calendar.

public DateTimePickerBuilder WeekNumber(bool weekNumber)

Parameters:weekNumberbool

The value that display or hide the week number of the Calendar.

Returns:

DateTimePickerBuilder

Example:

@( Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.Start(CalendarView.Month)
)