Class TimePicker

Inheritance
System.Object
EJTagHelper
TimePicker
Inherited Members
Namespace: Syncfusion.EJ2.Calendars
Assembly: Syncfusion.EJ2.dll
Syntax
public class TimePicker : EJTagHelper

Constructors

TimePicker()

Declaration
public TimePicker()

Properties

AllowEdit

Support for allowEdit has been provided from v16.2.46.

Declaration
public bool AllowEdit { get; set; }
Property Value
Type Description
System.Boolean

Blur

Triggers when the control loses the focus.

Declaration
public string Blur { get; set; }
Property Value
Type Description
System.String

Change

Triggers when the value is changed.

Declaration
public string Change { get; set; }
Property Value
Type Description
System.String

ClassName

Declaration
protected override string ClassName { get; }
Property Value
Type Description
System.String
Overrides

Cleared

Triggers when timepicker value is cleared using clear button.

Declaration
public string Cleared { get; set; }
Property Value
Type Description
System.String

Close

Triggers when the popup is closed.

Declaration
public string Close { get; set; }
Property Value
Type Description
System.String

Created

Triggers when the component is created.

Declaration
public string Created { get; set; }
Property Value
Type Description
System.String

CssClass

Specifies the root CSS class of the TimePicker that allows to customize the appearance by overriding the styles.

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

Destroyed

Triggers when the component is destroyed.

Declaration
public string Destroyed { get; set; }
Property Value
Type Description
System.String

Enabled

Specifies whether the component to be disabled or not.

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

EnableMask

Specifies whether it is a masked timepicker or not. By default the timepicker component render without masked input. If you need masked timepicker input then specify it as true.

Declaration
public bool EnableMask { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

Enable or disable the persisting component's state between the page reloads. If enabled, following list of states will be persisted.

  1. Value
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

FloatLabelType

Specifies the placeholder text to be floated. Possible values are: Never: The label will never float in the input when the placeholder is available. Always: The floating label will always float above the input. Auto: The floating label will float above the input after focusing or entering a value in the input.

Declaration
public FloatLabelType FloatLabelType { get; set; }
Property Value
Type Description
FloatLabelType

Focus

Triggers when the control gets focused.

Declaration
public string Focus { get; set; }
Property Value
Type Description
System.String

For

Declaration
public override ModelExpression For { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExpression
Overrides

Format

Specifies the format of value that is to be displayed in component. By default, the format is based on the culture.

For more details refer to Format documentation. {% codeBlock src='timepicker/format/index.md' %}{% endcodeBlock %}

Declaration
public string Format { get; set; }
Property Value
Type Description
System.String

HtmlAttributes

You can add the additional html attributes such as disabled, value etc., to the element. If you configured both property and equivalent html attribute then the component considers the property value. {% codeBlock src='timepicker/htmlAttributes/index.md' %}{% endcodeBlock %}

Declaration
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

IsFor

Declaration
protected override bool IsFor { get; }
Property Value
Type Description
System.Boolean
Overrides

ItemRender

Triggers while rendering the each popup list item.

Declaration
public string ItemRender { get; set; }
Property Value
Type Description
System.String

KeyConfigs

Customizes the key actions in TimePicker. For example, when using German keyboard, the key actions can be customized using these shortcuts.

Declaration
public object KeyConfigs { get; set; }
Property Value
Type Description
System.Object

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
public string Locale { get; set; }
Property Value
Type Description
System.String

MaskPlaceholder

Specifies the mask placeholder to be displayed on masked timepicker.

Declaration
public TimePickerMaskPlaceholder MaskPlaceholder { get; set; }
Property Value
Type Description
TimePickerMaskPlaceholder

Max

Gets or sets the maximum time value that can be allowed to select in TimePicker.

For more details refer to Time Range documentation.

Declaration
public object Max { get; set; }
Property Value
Type Description
System.Object

Min

Gets or sets the minimum time value that can be allowed to select in TimePicker.

For more details refer to Time Range documentation.

Declaration
public object Min { get; set; }
Property Value
Type Description
System.Object

NameSpace

Declaration
protected override string NameSpace { get; }
Property Value
Type Description
System.String
Overrides

Open

Triggers when the popup is opened.

Declaration
public string Open { get; set; }
Property Value
Type Description
System.String

OpenOnFocus

By default, the popup opens while clicking on the timepicker icon. If you want to open the popup while focusing the time input then specify its value as true.

Declaration
public bool OpenOnFocus { get; set; }
Property Value
Type Description
System.Boolean

Placeholder

Specifies the placeholder text that is displayed in textbox.

Declaration
public string Placeholder { get; set; }
Property Value
Type Description
System.String

Readonly

Specifies the component in readonly state.

Declaration
public bool Readonly { get; set; }
Property Value
Type Description
System.Boolean

ScrollTo

Specifies the scroll bar position if there is no value is selected in the popup list or the given value is not present in the popup list.

For more details refer to Time Duration sample. {% codeBlock src='timepicker/scrollTo/index.md' %}{% endcodeBlock %}

Declaration
public object ScrollTo { get; set; }
Property Value
Type Description
System.Object

ShowClearButton

Specifies whether to show or hide the clear icon.

Declaration
public bool ShowClearButton { get; set; }
Property Value
Type Description
System.Boolean

Step

Specifies the time interval between the two adjacent time values in the popup list.

For more details refer to Formatdocumentation.

Declaration
public double Step { get; set; }
Property Value
Type Description
System.Double

StrictMode

Specifies the component to act as strict so that, it allows to enter only a valid time value within a specified range or else resets to previous value. By default, strictMode is in false.

For more details refer to Strict Mode documentation.

Declaration
public bool StrictMode { get; set; }
Property Value
Type Description
System.Boolean

TagName

Declaration
protected override string TagName { get; }
Property Value
Type Description
System.String
Overrides

Value

Gets or sets the value of the component. The value is parsed based on the culture specific time format.

Declaration
public object Value { get; set; }
Property Value
Type Description
System.Object

Width

Gets or sets the width of the TimePicker component. The width of the popup is based on the width of the component.

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String

ZIndex

specifies the z-index value of the timePicker popup element.

Declaration
public int ZIndex { get; set; }
Property Value
Type Description
System.Int32