DateTimePickerBuilder

Properties

WriteAction - Func

Methods

Animation(System.Boolean)

Use to enable or disable animation of the popup element.

Parameters

enable - System.Boolean

The boolean value.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

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

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

Razor
 
            @(Html.Kendo().DateTimePicker()
                       .Name("DatePicker")
                       .Animation(animation =>
                       {
            	            animation.Open(open =>
            	            {
            	                open.SlideIn(SlideDirection.Down);
            	            })
                       })
            )
             

BindTo(System.Collections.Generic.IEnumerable)

Binds the TimeView to a list of DateTime objects.

Parameters

dates - System.Collections.Generic.IEnumerable<DateTime>

The dates.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

Razor
 
            @(Html.Kendo().DateTimePicker()
                       .Name("DateTimePicker")
                       .BindTo(new List<DateTime> { DateTime.Now })
            )
             

DisableDates(System.Collections.Generic.IEnumerable)

Specifies the disabled dates in the DateTimePicker widget.

Parameters

disableDates - System.Collections.Generic.IEnumerable<String>

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

DisableDates(System.DayOfWeek[])

Specifies the disabled dates in the DateTimePicker widget.

Parameters

days - System.DayOfWeek[]

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

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

DisableDates(System.String)

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

Parameters

handler - System.String

The function handler which will determine the disabled dates.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

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

Value(System.String)

Sets the value of the picker input

Parameters

date - System.String

The value that configures the value.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

Razor
 
            @(Html.Kendo().DateTimePicker()
                        .Name("dateTimePicker")
                        .Value(DateTime.Now)
            )
             

Value(System.Nullable)

Specifies the selected value.

Parameters

value - System.Nullable<DateTime>

The value that configures the value.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

Razor
 
            @(Html.Kendo().DateTimePicker()
                        .Name("dateTimePicker")
                        .Value(null)
            )
             

Enable(System.Boolean)

Enables or disables the picker.

Parameters

value - System.Boolean

The value that enables/disables the component.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

Razor
 
            @(Html.Kendo().DateTimePicker()
                        .Name("dateTimePicker")
                        .Enable(true)
            )
             

Footer(System.Boolean)

Enables/disables footer of the calendar popup.

Parameters

The footer that displayed or hidden for the component.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

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

FooterId(System.String)

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

Parameters

id - System.String

The id that displays the footer for the component.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

Razor
 
            @(Html.Kendo().DateTimePicker()
                        .Name("dateTimePicker")
                        .FooterId("widgetFooterId")
            )
             

Min(System.String)

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

Parameters

date - System.String

The minimum date that can be set for the Calendar.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

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

Max(System.String)

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

Parameters

date - System.String

The maximum date that can be set for the Calendar.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

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

MonthTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

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

Parameters

template - TemplateBuilder<TModel>

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

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

Razor
 
             @( Html.Kendo().DateTimePicker()
                        .Name("DateTimePicker")
                        .MonthTemplate(Html.Kendo().Template()
                            .AddHtml("<div>${data.value} </div>")
                        )
            )
             

MonthTemplate(System.Action)

Configures the content of cells of the Calendar.

Parameters

monthTemplateAction - System.Action<MonthTemplateBuilder>

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

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

Razor
 
             @( Html.Kendo().DateTimePicker()
                        .Name("DateTimePicker")
                        .MonthTemplate(month => month.Content("#= data.value #"))
            )
             

MonthTemplateId(System.String)

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

Parameters

id - System.String

The id to be used for rendering the cells for the Calendar.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

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

MonthTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

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

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view to be used for rendering the cells for the Calendar.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

Razor
 
             @( Html.Kendo().DateTimePicker()
                        .Name("dateTimePicker")
                        .MonthTemplateView(Html.Partial("WidgetMonthTemplate"))
            )
             

MonthTemplateHandler(System.String)

MonthTemplate function handler to be used for rendering the cells of the Calendar.

Parameters

templateHandler - System.String

The name of the JavaScript function to be used for rendering the cells for the Calendar.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

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

MonthTemplate(System.String)

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

Parameters

content - System.String

The content to be used for rendering the cells for the Calendar.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

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

Interval(System.Action)

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.

Parameters

action - System.Action<IntervalSettingsBuilder>

The interval settings.

RETURNS

A reference to the current DateTimePickerBuilder instance, to allow for method chaining.

Example

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

AdaptiveTitle(System.String)

Allows customization of the title's text in the adaptive view of the component.

Parameters

value - System.String

The value for AdaptiveTitle

RETURNS

Returns the current DateTimePickerBuilder instance.

AdaptiveSubtitle(System.String)

Allows customization of the subtitle's text in the adaptive view of the component.

Parameters

value - System.String

The value for AdaptiveSubtitle

RETURNS

Returns the current DateTimePickerBuilder instance.

ARIATemplate(System.String)

Specifies a template used to populate 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

RETURNS

Returns the current DateTimePickerBuilder instance.

ARIATemplateId(System.String)

Specifies a template used to populate 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

RETURNS

Returns the current DateTimePickerBuilder instance.

ARIATemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

Specifies a template used to populate 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

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for ARIATemplate

RETURNS

Returns the current DateTimePickerBuilder instance.

ARIATemplateHandler(System.String)

Specifies a template used to populate 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

templateHandler - System.String

The handler that returs the template for ARIATemplate

RETURNS

Returns the current DateTimePickerBuilder instance.

ARIATemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Specifies a template used to populate 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

template - TemplateBuilder<TModel>

A Template component that configures the ariatemplate.

RETURNS

Returns the current DateTimePickerBuilder instance.

AutoAdjust(System.Boolean)

If this property is enabled and you have configured min and/or max values, and the user enters a value that falls out of that range, the value will automatically be set to either the minimum or maximum allowed value. This property has effect only when the dateInput of the component is enabled.

Parameters

value - System.Boolean

The value for AutoAdjust

RETURNS

Returns the current DateTimePickerBuilder instance.

AutoCorrectParts(System.Boolean)

Sets a value that indicates whether to automatically correct the segment when out of range. In order to work, dateInput prop should be set to true.

Parameters

value - System.Boolean

The value for AutoCorrectParts

RETURNS

Returns the current DateTimePickerBuilder instance.

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

RETURNS

Returns the current DateTimePickerBuilder instance.

Culture(System.String)

Specifies the culture info used by the widget.

Parameters

value - System.String

The value for Culture

RETURNS

Returns the current DateTimePickerBuilder instance.

DateInput(System.Boolean)

Specifies if the DateTimePicker will use DateInput for editing value

Parameters

value - System.Boolean

The value for DateInput

RETURNS

Returns the current DateTimePickerBuilder instance.

DateInput()

Specifies if the DateTimePicker will use DateInput for editing value

RETURNS

Returns the current DateTimePickerBuilder instance.

Dates(System.DateTime[])

Specifies a list of dates, which will be passed to the month template of the DateView. All dates, which match the date portion of the selected date will be used to re-bind the TimeView.

Parameters

value - System.DateTime[]

The value for Dates

RETURNS

Returns the current DateTimePickerBuilder instance.

EndTime(System.DateTime)

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

Parameters

value - System.DateTime

The value for EndTime

RETURNS

Returns the current DateTimePickerBuilder instance.

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

RETURNS

Returns the current DateTimePickerBuilder instance.

Format(System.String)

Specifies the format, which is used to format the value of the DateTimePicker 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

RETURNS

Returns the current DateTimePickerBuilder instance.

InputMode(System.String)

Specifies the inputmode attribute of the inner <input /> element. It is used to specify the type of on-screen keyboard that should be displayed when the user focuses the input.

Parameters

value - System.String

The value for InputMode

RETURNS

Returns the current DateTimePickerBuilder instance.

Label(System.Action)

Adds a label before the datetimepicker. If the datetimepicker 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<DateTimePickerLabelSettingsBuilder>

The configurator for the label setting.

RETURNS

Returns the current instance of DateTimePickerBuilder .

Interval(System.Double)

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

Parameters

value - System.Double

The value for Interval

RETURNS

Returns the current DateTimePickerBuilder instance.

Max(System.DateTime)

Specifies the maximum date, which the calendar can show.

Parameters

value - System.DateTime

The value for Max

RETURNS

Returns the current DateTimePickerBuilder instance.

Messages(System.Action)

Allows localization of the strings that are used in the widget.

Parameters

configurator - System.Action<DateTimePickerMessagesSettingsBuilder>

The configurator for the messages setting.

RETURNS

Returns the current instance of DateTimePickerBuilder .

Min(System.DateTime)

Specifies the minimum date that the calendar can show.

Parameters

value - System.DateTime

The value for Min

RETURNS

Returns the current DateTimePickerBuilder instance.

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<DateTimePickerPopupSettingsBuilder>

The configurator for the popup setting.

RETURNS

Returns the current instance of DateTimePickerBuilder .

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

RETURNS

Returns the current DateTimePickerBuilder instance.

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.

RETURNS

Returns the current DateTimePickerBuilder instance.

ParseFormats(System.String[])

Specifies the formats, which are used to parse the value set with value() method or by direct input. If not set the value of the options.format and options.timeFormat will be used. Note that value of the format option is always used. The timeFormat value also will be used if defined.

Parameters

value - System.String[]

The value for ParseFormats

RETURNS

Returns the current DateTimePickerBuilder instance.

StartTime(System.DateTime)

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

Parameters

value - System.DateTime

The value for StartTime

RETURNS

Returns the current DateTimePickerBuilder instance.

TimeFormat(System.String)

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

Parameters

value - System.String

The value for TimeFormat

RETURNS

Returns the current DateTimePickerBuilder instance.

Value(System.DateTime)

Specifies the selected value.

Parameters

value - System.DateTime

The value for Value

RETURNS

Returns the current DateTimePickerBuilder instance.

Start(Kendo.Mvc.UI.CalendarView)

Represents available types of calendar views.

Parameters

value - CalendarView

The value for Start

RETURNS

Returns the current DateTimePickerBuilder instance.

Depth(Kendo.Mvc.UI.CalendarView)

Specifies the navigation depth.

Parameters

value - CalendarView

The value for Depth

RETURNS

Returns the current DateTimePickerBuilder instance.

Size(Kendo.Mvc.UI.ComponentSize)

Sets the size of the component.

Parameters

value - ComponentSize

The value for Size

RETURNS

Returns the current DateTimePickerBuilder instance.

Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

Parameters

value - Rounded

The value for Rounded

RETURNS

Returns the current DateTimePickerBuilder instance.

FillMode(Kendo.Mvc.UI.FillMode)

Sets a value controlling how the color is applied.

Parameters

value - FillMode

The value for FillMode

RETURNS

Returns the current DateTimePickerBuilder instance.

AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)

Specifies the adaptive rendering of the component.

Parameters

value - AdaptiveMode

The value for AdaptiveMode

RETURNS

Returns the current DateTimePickerBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<DateTimePickerEventBuilder>

The client events action.

RETURNS

Returns the current DateTimePickerBuilder instance.

Example

Razor
 
            @(Html.Kendo().DateTimePicker()
                  .Name("DateTimePicker")
                  .Events(events => events
                      .Change("onChange")
                  )
            )
             

UseMvvmInitialization(System.Boolean)

Specifies if the component should be initialized through MVVM on the client.

Parameters

value - System.Boolean

The value.

RETURNS

Returns the current instance.

UseMvvmInitialization()

Specifies if the component should be initialized through MVVM on the client.

RETURNS

Returns the current instance.

ToComponent()

Returns the internal view component.

RETURNS

The instance that represents the component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

RETURNS

Returns the current instance.

Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

RETURNS

Returns the current instance.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

RETURNS

Returns the current instance.

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with

Parameters

deferred - System.Boolean

RETURNS

Returns a DeferredWidgetBuilder instance.

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

RETURNS

Returns the current instance.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The HTML attributes.

RETURNS

Returns the current instance.

ScriptAttributes(System.Object,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Object

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

Render()

Renders the component in place.

ToHtmlString()

Returns the HTML representation of the component.

WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)

Parameters

writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder

ToClientTemplate()

Returns the client template for the component.

AsModule(System.Boolean)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

Parameters

value - System.Boolean

RETURNS

Returns the current instance.

In this article
PropertiesWriteAction - FuncMethodsAnimation(System.Boolean)Animation(System.Action)BindTo(System.Collections.Generic.IEnumerable)DisableDates(System.Collections.Generic.IEnumerable)DisableDates(System.DayOfWeek[])DisableDates(System.String)Value(System.String)Value(System.Nullable)Enable(System.Boolean)Footer(System.Boolean)FooterId(System.String)Min(System.String)Max(System.String)MonthTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)MonthTemplate(System.Action)MonthTemplateId(System.String)MonthTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)MonthTemplateHandler(System.String)MonthTemplate(System.String)Interval(System.Action)AdaptiveTitle(System.String)AdaptiveSubtitle(System.String)ARIATemplate(System.String)ARIATemplateId(System.String)ARIATemplateView(Microsoft.AspNetCore.Html.IHtmlContent)ARIATemplateHandler(System.String)ARIATemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)AutoAdjust(System.Boolean)AutoCorrectParts(System.Boolean)ComponentType(System.String)Culture(System.String)DateInput(System.Boolean)DateInput()Dates(System.DateTime[])EndTime(System.DateTime)Footer(System.String)Format(System.String)InputMode(System.String)Label(System.Action)Interval(System.Double)Max(System.DateTime)Messages(System.Action)Min(System.DateTime)Popup(System.Action)WeekNumber(System.Boolean)WeekNumber()ParseFormats(System.String[])StartTime(System.DateTime)TimeFormat(System.String)Value(System.DateTime)Start(Kendo.Mvc.UI.CalendarView)Depth(Kendo.Mvc.UI.CalendarView)Size(Kendo.Mvc.UI.ComponentSize)Rounded(Kendo.Mvc.UI.Rounded)FillMode(Kendo.Mvc.UI.FillMode)AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)Events(System.Action)UseMvvmInitialization(System.Boolean)UseMvvmInitialization()ToComponent()Expression(System.String)Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)Name(System.String)Deferred(System.Boolean)HtmlAttributes(System.Object)HtmlAttributes(System.Collections.Generic.IDictionary)ScriptAttributes(System.Object,System.Boolean)ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)Render()ToHtmlString()WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)ToClientTemplate()AsModule(System.Boolean)
Not finding the help you need?
Contact Support