TimePickerBuilder
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
Returns the current TimePickerBuilder instance.
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.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@( Html.Kendo().DatePicker()
.Name("DatePicker")
.Animation(animation =>
{
animation.Open(open =>
{
open.SlideIn(SlideDirection.Down);
})
})
)
Enable(System.Boolean)
Enables or disables the picker.
Parameters
value - System.Boolean
The value which will enable/disable the picker.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.Enable(false)
)
Value(System.Nullable)
Sets the value of the picker input
Parameters
date - System.Nullable<DateTime>
The value of the TimePicker.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.Value(DateTime.Now)
)
Value(System.String)
Sets the value of the picker input
Parameters
date - System.String
The value of the TimePicker.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.Value("12/11/2024")
)
Value(System.Nullable)
Sets the value of the picker input
Parameters
time - System.Nullable<TimeSpan>
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.Value(DateTime.Now)
)
Value(System.TimeOnly)
Sets the value of the timepicker input
Parameters
value - System.TimeOnly
The time value.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.Value(new TimeOnly())
)
Value(System.Nullable)
Sets the value of the picker input
Parameters
value - System.Nullable<TimeOnly>
The value of the TimePicker.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.Value(DateTime.Now)
)
Min(System.TimeSpan)
Sets the minimum time, which can be selected in timepicker
Parameters
value - System.TimeSpan
The minumum time.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.Min(new TimeSpan(10, 12, 30, 10, 10))
)
Min(System.String)
Sets the minimum time, which can be selected in timepicker
Parameters
value - System.String
The minimum time.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.Min("10:30")
)
Max(System.TimeSpan)
Sets the maximum time, which can be selected in timepicker
Parameters
value - System.TimeSpan
The maximum time.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.Max(new TimeSpan(10, 12, 30, 10, 10))
)
Max(System.String)
Sets the maximum time, which can be selected in timepicker
Parameters
value - System.String
The Maximum time.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.Max("12:30")
)
BindTo(System.Collections.Generic.IList)
Binds the TimePicker to a list of DateTime objects.
Parameters
dates - System.Collections.Generic.IList<DateTime>
The list of DateTime objects.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@( Html.Kendo().TimePicker()
.Name("TimePicker")
.BindTo(new List<DateTime>
{
DateTime.Now
}))
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
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("timePicker")
.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 TimePickerBuilder 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 TimePickerBuilder 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 TimePickerBuilder 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 TimePickerBuilder 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 TimePickerBuilder instance.
Culture(System.String)
Specifies the culture info used by the widget.
Parameters
value - System.String
The value for Culture
RETURNS
Returns the current TimePickerBuilder instance.
DateInput(System.Boolean)
Specifies if the TimePicker will use DateInput for editing value
Parameters
value - System.Boolean
The value for DateInput
RETURNS
Returns the current TimePickerBuilder instance.
DateInput()
Specifies if the TimePicker will use DateInput for editing value
RETURNS
Returns the current TimePickerBuilder instance.
Dates(System.DateTime[])
Specifies a list of dates, which are shown in the time drop-down list. If not set, the TimePicker will auto-generate the available times.
Parameters
value - System.DateTime[]
The value for Dates
RETURNS
Returns the current TimePickerBuilder instance.
FocusTime(System.DateTime)
Specifies a time that will be focused inside the popup when opened.
Parameters
value - System.DateTime
The value for FocusTime
RETURNS
Returns the current TimePickerBuilder instance.
Format(System.String)
Specifies the format, which is used to format the value of the TimePicker 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 TimePickerBuilder 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 TimePickerBuilder instance.
Label(System.Action)
Adds a label before the timepicker. If the timepicker 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<TimePickerLabelSettingsBuilder>
The configurator for the label setting.
RETURNS
Returns the current instance of TimePickerBuilder .
Interval(System.Int32)
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.Int32
The value for Interval
RETURNS
Returns the current TimePickerBuilder instance.
Max(System.DateTime)
Specifies the end value in the popup list.
Parameters
value - System.DateTime
The value for Max
RETURNS
Returns the current TimePickerBuilder instance.
Messages(System.Action)
Allows localization of the strings that are used in the widget.
Parameters
configurator - System.Action<TimePickerMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of TimePickerBuilder .
Min(System.DateTime)
Specifies the start value in the popup list.
Parameters
value - System.DateTime
The value for Min
RETURNS
Returns the current TimePickerBuilder instance.
ParseFormats(System.String[])
Specifies the formats, which are used to parse the value set with the value method or by direct input. If not set the value of the options.format will be used. Note that value of the format option is always used.
Parameters
value - System.String[]
The value for ParseFormats
RETURNS
Returns the current TimePickerBuilder 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<TimePickerPopupSettingsBuilder>
The configurator for the popup setting.
RETURNS
Returns the current instance of TimePickerBuilder .
Value(System.DateTime)
Specifies the selected time.
Parameters
value - System.DateTime
The value for Value
RETURNS
Returns the current TimePickerBuilder instance.
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
RETURNS
Returns the current TimePickerBuilder instance.
Rounded(Kendo.Mvc.UI.Rounded)
Sets a value controlling the border radius.
Parameters
value - Rounded
The value for Rounded
RETURNS
Returns the current TimePickerBuilder 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 TimePickerBuilder instance.
AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)
Specifies the adaptive rendering of the component.
Parameters
value - AdaptiveMode
The value for AdaptiveMode
RETURNS
Returns the current TimePickerBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<TimePickerEventBuilder>
The client events action.
RETURNS
Returns the current TimePickerBuilder instance.
Example
@(Html.Kendo().TimePicker()
.Name("TimePicker")
.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.