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.
Example
@(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.
Example
@(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.
Example
@(Html.Kendo().DateTimePicker()
.Name("DateTimePicker")
.BindTo(new List<DateTime> { DateTime.Now })
)
DisableDates(System.Collections.Generic.IEnumerable)
Parameters
disableDates - System.Collections.Generic.IEnumerable<String>
DisableDates(System.DayOfWeek[])
Specifies the disabled dates in the DateTimePicker widget.
Parameters
days - System.DayOfWeek[]
Example
@(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.
Example
@( 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.
Example
@(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.
Example
@(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.
Example
@(Html.Kendo().DateTimePicker()
.Name("dateTimePicker")
.Enable(true)
)
Footer(System.Boolean)
Enables/disables footer of the calendar popup.
Parameters
footer - System.Boolean
The footer that displayed or hidden for the component.
Example
@(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.
Example
@(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.
Example
@(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.
Example
@(Html.Kendo().DateTimePicker()
.Name("dateTimePicker")
.Max(DateTime.Today)
)
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.
Example
@(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.
Example
@( 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.
Example
@( 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.
Example
@(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.
Example
@(Html.Kendo().DateTimePicker()
.Name("dateTimePicker")
.ComponentType("modern")
.Interval(interval => interval
.Hour(3);
.Minute(20);
.Second(15);
)
)
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
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
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
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
ARIATemplate(Kendo.Mvc.UI.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.
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
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
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 DateTimePicker will use DateInput for editing value
Parameters
value - System.Boolean
The value for DateInput
DateInput()
Specifies if the DateTimePicker will use DateInput for editing value
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
EndTime(System.DateTime)
If set, specifies the latest time the TimeView can show.
Parameters
value - System.DateTime
The value for EndTime
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 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
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.
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
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<DateTimePickerMessagesSettingsBuilder>
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<DateTimePickerPopupSettingsBuilder>
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 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
StartTime(System.DateTime)
If set, specifies the earliest time the TimeView can show.
Parameters
value - System.DateTime
The value for StartTime
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
Value(System.DateTime)
Specifies the selected value.
Parameters
value - System.DateTime
The value for Value
Start(Kendo.Mvc.UI.CalendarView)
Represents available types of calendar views.
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<DateTimePickerMonthTemplateSettingsBuilder>
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
AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)
Specifies the adaptive rendering of the component.
Parameters
value - AdaptiveMode
The value for AdaptiveMode
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<DateTimePickerEventBuilder>
The client events action.
Example
@(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.
UseMvvmInitialization()
Specifies if the component should be initialized through MVVM on the client.
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.
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.
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.
Render()
Renders the component in place.
ToHtmlString()
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.