Class TimePickerPropertiesBuilder

Inheritance

System.Object

TimePickerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class TimePickerPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

TimePickerPropertiesBuilder()

Initializes a new instance of the TimePickerPropertiesBuilder class.

Declaration

public TimePickerPropertiesBuilder()

TimePickerPropertiesBuilder(TimePicker)

Initializes a new instance of the TimePickerPropertiesBuilder class by the specified time picker object.

Declaration

public TimePickerPropertiesBuilder(TimePicker timepicker)

Parameters

Type	Name	Description
TimePicker	timepicker

Fields

timepicker

Specifies the instance of the TimePicker class.

Declaration

public TimePicker timepicker

Field Value

Type	Description
TimePicker

Properties

Items

Gets or sets the value indicating the range of time to be disabled.

Declaration

public List<DisableTimeRange> Items { get; set; }

Property Value

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

Methods

ClientSideEvents(Action<TimePickerClientSideEventsBuilder>)

Specifies the time picker client side events.

Declaration

public TimePickerPropertiesBuilder ClientSideEvents(Action<TimePickerClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<TimePickerClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
TimePickerPropertiesBuilder

CssClass(String)

Specifies the root CSS class to time picker for theme customization.

Declaration

public TimePickerPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
TimePickerPropertiesBuilder

DisableTimeRanges(Action<DisableTimesAdder>)

Specifies the list of times to be disabled in the time picker popup.

Declaration

public TimePickerPropertiesBuilder DisableTimeRanges(Action<DisableTimesAdder> fields)

Parameters

Type	Name	Description
System.Action<DisableTimesAdder>	fields

Returns

Type	Description
TimePickerPropertiesBuilder

EnableAnimation()

Specifies the animation effect when time picker popup opens/closes.

Declaration

public TimePickerPropertiesBuilder EnableAnimation()

Returns

Type	Description
TimePickerPropertiesBuilder

EnableAnimation(Boolean)

Specifies the animation effect when time picker popup opens/closes with the specified argument.

Declaration

public TimePickerPropertiesBuilder EnableAnimation(bool enableAnimation)

Parameters

Type	Name	Description
System.Boolean	enableAnimation

Returns

Type	Description
TimePickerPropertiesBuilder

Enabled()

Specifies the scroller control can respond to user interaction.

Declaration

public TimePickerPropertiesBuilder Enabled()

Returns

Type	Description
TimePickerPropertiesBuilder

Enabled(Boolean)

Specifies the scroller control can respond to user interaction with the specified boolean argument.

Declaration

public TimePickerPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

Returns

Type	Description
TimePickerPropertiesBuilder

EnablePersistence()

Specifies to persists time picker model upon form post or browser refresh.

Declaration

public TimePickerPropertiesBuilder EnablePersistence()

Returns

Type	Description
TimePickerPropertiesBuilder

EnablePersistence(Boolean)

Specifies to persists time picker model upon form post or browser refresh with the boolean specified argument.

Declaration

public TimePickerPropertiesBuilder EnablePersistence(bool enablePersistence)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
TimePickerPropertiesBuilder

EnableRTL()

Renders time picker dropdown and input field in right to left direction.

Declaration

public TimePickerPropertiesBuilder EnableRTL()

Returns

Type	Description
TimePickerPropertiesBuilder

EnableRTL(Boolean)

Renders time picker dropdown and input field in Right to Left direction with boolean argument.

Declaration

public TimePickerPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL

Returns

Type	Description
TimePickerPropertiesBuilder

EnableStrictMode(Boolean)

Specifies to allow the invalid/out of range time on time picker input field

Declaration

public TimePickerPropertiesBuilder EnableStrictMode(bool enableStrictMode)

Parameters

Type	Name	Description
System.Boolean	enableStrictMode

Returns

Type	Description
TimePickerPropertiesBuilder

Height(String)

Specifies the height of the time picker input field.

Declaration

public TimePickerPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
TimePickerPropertiesBuilder

HourInterval(Int32)

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

Declaration

public TimePickerPropertiesBuilder HourInterval(int hourInterval)

Parameters

Type	Name	Description
System.Int32	hourInterval

Returns

Type	Description
TimePickerPropertiesBuilder

HtmlAttributes(IDictionary<String, Object>)

Specifies to map the field of HTML attributes.

Declaration

public TimePickerPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

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

Returns

Type	Description
TimePickerPropertiesBuilder

Interval(Single)

Specifies the time interval between the two adjacent time values in the dropdown.

Declaration

public TimePickerPropertiesBuilder Interval(float interval)

Parameters

Type	Name	Description
System.Single	interval

Returns

Type	Description
TimePickerPropertiesBuilder

Locale(String)

Specifies to localize the time picker's language and format.

Declaration

public TimePickerPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
TimePickerPropertiesBuilder

MaxTime(String)

Specifies the maximum time to be displayed in time picker popup.

Declaration

public TimePickerPropertiesBuilder MaxTime(string maxTime)

Parameters

Type	Name	Description
System.String	maxTime

Returns

Type	Description
TimePickerPropertiesBuilder

MinTime(String)

Specifies the minimum time to be displayed in time picker popup.

Declaration

public TimePickerPropertiesBuilder MinTime(string minTime)

Parameters

Type	Name	Description
System.String	minTime

Returns

Type	Description
TimePickerPropertiesBuilder

MinutesInterval(Int32)

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

Declaration

public TimePickerPropertiesBuilder MinutesInterval(int minutesInterval)

Parameters

Type	Name	Description
System.Int32	minutesInterval

Returns

Type	Description
TimePickerPropertiesBuilder

PopupHeight(String)

Specifies the height of the time picker dropdown.

Declaration

public TimePickerPropertiesBuilder PopupHeight(string popupHeight)

Parameters

Type	Name	Description
System.String	popupHeight

Returns

Type	Description
TimePickerPropertiesBuilder

PopupWidth(String)

Specifies the width of the time picker dropdown.

Declaration

public TimePickerPropertiesBuilder PopupWidth(string popupWidth)

Parameters

Type	Name	Description
System.String	popupWidth

Returns

Type	Description
TimePickerPropertiesBuilder

ReadOnly()

Restricts to pick the time from the popup and edit the time in the input field.

Declaration

public TimePickerPropertiesBuilder ReadOnly()

Returns

Type	Description
TimePickerPropertiesBuilder

ReadOnly(Boolean)

Restricts to pick the time from the popup and edit the time in the input field with the specified boolean argument.

Declaration

public TimePickerPropertiesBuilder ReadOnly(bool readOnly)

Parameters

Type	Name	Description
System.Boolean	readOnly

Returns

Type	Description
TimePickerPropertiesBuilder

Render()

Renders this instance.

Declaration

public void Render()

SecondsInterval(Int32)

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

Declaration

public TimePickerPropertiesBuilder SecondsInterval(int secondsInterval)

Parameters

Type	Name	Description
System.Int32	secondsInterval

Returns

Type	Description
TimePickerPropertiesBuilder

ShowPopupButton()

Shows or hides the time icon button in the input field of the time picker.

Declaration

public TimePickerPropertiesBuilder ShowPopupButton()

Returns

Type	Description
TimePickerPropertiesBuilder

ShowPopupButton(Boolean)

Shows or hides the date icon button in the textbox with the specified argument.

Declaration

public TimePickerPropertiesBuilder ShowPopupButton(bool showPopupButton)

Parameters

Type	Name	Description
System.Boolean	showPopupButton

Returns

Type	Description
TimePickerPropertiesBuilder

ShowRoundedCorner()

Specifies the time picker popup and input field with rounded corners.

Declaration

public TimePickerPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
TimePickerPropertiesBuilder

ShowRoundedCorner(Boolean)

Specifies the time picker popup and input field with rounded corners by the specified argument.

Declaration

public TimePickerPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)

Parameters

Type	Name	Description
System.Boolean	showRoundedCorner

Returns

Type	Description
TimePickerPropertiesBuilder

TimeFormat(String)

Specifies to time format to be displayed on time picker input field.

Declaration

public TimePickerPropertiesBuilder TimeFormat(string timeFormat)

Parameters

Type	Name	Description
System.String	timeFormat

Returns

Type	Description
TimePickerPropertiesBuilder

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

ValidationMessages(Action<TimePickerPropertiesBuilder.TimePickerValidationMessageBuilder>)

Sets jQuery validation messages for TimePicker input.

Declaration

public TimePickerPropertiesBuilder ValidationMessages(Action<TimePickerPropertiesBuilder.TimePickerValidationMessageBuilder> validationMessage)

Parameters

Type	Name	Description
System.Action<TimePickerPropertiesBuilder.TimePickerValidationMessageBuilder>	validationMessage

Returns

Type	Description
TimePickerPropertiesBuilder

ValidationMessages(Dictionary<String, Object>)

Sets jQuery validation messages for TimePicker input.

Declaration

public TimePickerPropertiesBuilder ValidationMessages(Dictionary<string, object> validationMessage)

Parameters

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

Returns

Type	Description
TimePickerPropertiesBuilder

ValidationRules(Action<TimePickerPropertiesBuilder.TimePickerValidationRuleBuilder>)

Sets jQuery validation custom rules for TimePicker input.

Declaration

public TimePickerPropertiesBuilder ValidationRules(Action<TimePickerPropertiesBuilder.TimePickerValidationRuleBuilder> validationRule)

Parameters

Type	Name	Description
System.Action<TimePickerPropertiesBuilder.TimePickerValidationRuleBuilder>	validationRule

Returns

Type	Description
TimePickerPropertiesBuilder

ValidationRules(Dictionary<String, Object>)

Sets jQuery validation messages for TimePicker input.

Declaration

public TimePickerPropertiesBuilder ValidationRules(Dictionary<string, object> validationRule)

Parameters

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

Returns

Type	Description
TimePickerPropertiesBuilder

Value(DateTime)

Specifies the time value with DateTime type argument.

Declaration

public TimePickerPropertiesBuilder Value(DateTime value)

Parameters

Type	Name	Description
System.DateTime	value

Returns

Type	Description
TimePickerPropertiesBuilder

Value(String)

Specifies the time value with string type argument.

Declaration

public TimePickerPropertiesBuilder Value(string value)

Parameters

Type	Name	Description
System.String	value

Returns

Type	Description
TimePickerPropertiesBuilder

WatermarkText(String)

Specifies watermark text to be displayed in input field.

Declaration

public TimePickerPropertiesBuilder WatermarkText(string watermarkText)

Parameters

Type	Name	Description
System.String	watermarkText

Returns

Type	Description
TimePickerPropertiesBuilder

Width(String)

Specifies the width of the time picker input field.

Declaration

public TimePickerPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
TimePickerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString