Class TimePicker

Represents the TimePicker UI element.

Inheritance

System.Object

CommonControl

TimePicker

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonControl.RaisePostBackEvent(String)

CommonControl.OnInit(EventArgs)

CommonControl.OnLoad(EventArgs)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class TimePicker : CommonControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

TimePicker()

Declaration

public TimePicker()

Properties

ClientSideOnBeforeChange

Gets or sets a value indicating this event gets fired when the time value changed in the time picker.

Declaration

public string ClientSideOnBeforeChange { get; set; }

Property Value

Type	Description
System.String

ClientSideOnBeforeOpen

Gets or sets a value indicating this event gets fired before opening the time picker dropdown.

Declaration

public string ClientSideOnBeforeOpen { get; set; }

Property Value

Type	Description
System.String

ClientSideOnChange

Gets or sets a value indicating this event gets fired when the time value changes.

Declaration

public string ClientSideOnChange { get; set; }

Property Value

Type	Description
System.String

ClientSideOnClose

Gets or sets a value indicating this event gets fired when the time picker dropdown closed.

Declaration

public string ClientSideOnClose { get; set; }

Property Value

Type	Description
System.String

ClientSideOnCreate

Gets or sets a value indicating this event gets fired when time picker is created successfully.

Declaration

public string ClientSideOnCreate { get; set; }

Property Value

Type	Description
System.String

ClientSideOnDestroy

Gets or sets a value indicating this event gets fired when the time picker is destroyed successfully.

Declaration

public string ClientSideOnDestroy { get; set; }

Property Value

Type	Description
System.String

ClientSideOnFocusIn

Gets or sets a value indicating this event gets fired when the time picker input field receives focus.

Declaration

public string ClientSideOnFocusIn { get; set; }

Property Value

Type	Description
System.String

ClientSideOnFocusOut

Gets or sets a value indicating this event gets fired when the time picker input field loses focus.

Declaration

public string ClientSideOnFocusOut { get; set; }

Property Value

Type	Description
System.String

ClientSideOnOpen

Gets or sets a value indicating this event gets fired when the time picker dropdown opened.

Declaration

public string ClientSideOnOpen { get; set; }

Property Value

Type	Description
System.String

ClientSideOnSelect

Gets or sets a value indicating this event gets fired when the value is selected from the time picker dropdown.

Declaration

public string ClientSideOnSelect { get; set; }

Property Value

Type	Description
System.String

CssClass

Gets or sets the root CSS class to time picker for theme customization.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String

DisableTimeRanges

Gets or sets the list of times to be disabled in the time picker.

Declaration

[JsonProperty("disableTimeRanges")]
public List<DisableTimeRange> DisableTimeRanges { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<DisableTimeRange>

EnableAnimation

Gets or sets the value indicating the animation effect when time picker popup opens/closes.

Declaration

public bool EnableAnimation { get; set; }

Property Value

Type	Description
System.Boolean

Enabled

Gets or sets a value indicating whether the control can respond to user interaction.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

EnablePersistence

Gets or set the value indicating time picker model value even after form post back/browser refresh sustains or not.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableRTL

Gets or sets the value to align the input field and popup in right to left direction.

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean

EnableStrictMode

Gets or sets a value to allow the invalid date in the time picker input field.

Declaration

public bool EnableStrictMode { get; set; }

Property Value

Type	Description
System.Boolean

Height

Gets or sets the height of the time picker input field.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

HourInterval

Gets or sets the increment step value of hours for changes through keyboard or mouse interaction.

Declaration

public int HourInterval { get; set; }

Property Value

Type	Description
System.Int32

HtmlAttributes

Declaration

public IDictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

Interval

Gets or sets the time interval(in minutes) between the two adjacent time values in the dropdown.

Declaration

public float Interval { get; set; }

Property Value

Type	Description
System.Single

Locale

Gets or sets a value to localize the time picker language and format.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

MaxTime

Gets or sets a value indicating the maximum value of time picker.

Declaration

public string MaxTime { get; set; }

Property Value

Type	Description
System.String

MinTime

Gets or sets a value indicating the minimum time value of time picker.

Declaration

public string MinTime { get; set; }

Property Value

Type	Description
System.String

MinutesInterval

Gets or sets the increment step value of minutes for changes through keyboard or mouse interaction.

Declaration

public int MinutesInterval { get; set; }

Property Value

Type	Description
System.Int32

Model

Gets or sets the time picker model object of the time picker properties.

Declaration

[JsonIgnore]
public TimePickerProperties Model { get; set; }

Property Value

Type	Description
TimePickerProperties

PopupHeight

Gets or sets the height of the time picker dropdown.

Declaration

public string PopupHeight { get; set; }

Property Value

Type	Description
System.String

PopupWidth

Gets or sets the width of the time picker dropdown.

Declaration

public string PopupWidth { get; set; }

Property Value

Type	Description
System.String

ReadOnly

Gets or sets a value indicating editing/selecting the time in time picker is allowed or not.

Declaration

public bool ReadOnly { get; set; }

Property Value

Type	Description
System.Boolean

SecondsInterval

Gets or sets the increment step value of seconds for changes through keyboard or mouse interaction.

Declaration

public int SecondsInterval { get; set; }

Property Value

Type	Description
System.Int32

ShowPopupButton

Gets or sets the value indicating time icon button in the input field.

Declaration

public bool ShowPopupButton { get; set; }

Property Value

Type	Description
System.Boolean

ShowRoundedCorner

Gets or sets a value indicating the time picker pop and input field with rounded corners or.

Declaration

public bool ShowRoundedCorner { get; set; }

Property Value

Type	Description
System.Boolean

TimeFormat

Gets or sets the value indicating the time format to be displayed on time picker input field.

Declaration

public string TimeFormat { get; set; }

Property Value

Type	Description
System.String

ValidationMessages

Declaration

public List<KeyValue> ValidationMessages { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<KeyValue>

ValidationRules

Declaration

public List<KeyValue> ValidationRules { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<KeyValue>

Value

Gets or sets the time value.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String

WatermarkText

Gets or sets the place holder value for time picker input field.

Declaration

public string WatermarkText { get; set; }

Property Value

Type	Description
System.String

Width

Gets or sets the width of the time picker input field.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

DependentScripts()

Specifies the dependent scripts.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>

GetDependentFiles()

Specifies the the dependent files.

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>

Overrides

CommonControl.GetDependentFiles()

LoadViewState(Object)

Restores view-state information from a previous page request.

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state

Overrides

CommonControl.LoadViewState(Object)

OnPreRender(EventArgs)

Modifying server controls before sending them to the client.

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

PostBackEventHandler(String, Dictionary<String, Object>)

Specifies the handler for server side events.

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Renders the time picker instance.

Declaration

public string Render()

Returns

Type	Description
System.String

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonControl.Render(HtmlTextWriter)

UpdateServerModel(Dictionary<String, Object>)

Updates the server model with client model.

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel

Overrides

CommonControl.UpdateServerModel(Dictionary<String, Object>)

Events

FocusOut

Represents the focusout event handler of the time picker.

Declaration

public event TimePicker.TimePickerEventHandler FocusOut

Event Type

Type	Description
TimePicker.TimePickerEventHandler

Select

Represents the select event handler of the time picker.

Declaration

public event TimePicker.TimePickerEventHandler Select

Event Type

Type	Description
TimePicker.TimePickerEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService