ASP.NET MVC - EJ2

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TimePickerBuilder

    Show / Hide Table of Contents

    Class TimePickerBuilder

    Inheritance
    System.Object
    ControlBuilder
    TimePickerBuilder
    Inherited Members
    ControlBuilder.Context
    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.EJ2.Calendars
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class TimePickerBuilder : ControlBuilder

    Constructors

    TimePickerBuilder()

    Declaration
    public TimePickerBuilder()

    TimePickerBuilder(TimePicker)

    Declaration
    public TimePickerBuilder(TimePicker model)
    Parameters
    Type Name Description
    TimePicker model

    Fields

    model

    Declaration
    public TimePicker model
    Field Value
    Type Description
    TimePicker

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

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

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    AllowEdit(Boolean)

    Support for allowEdit has been provided from v16.2.46.

    Declaration
    public TimePickerBuilder AllowEdit(bool allowEdit = true)
    Parameters
    Type Name Description
    System.Boolean allowEdit
    Returns
    Type Description
    TimePickerBuilder

    Blur(String)

    Triggers when the control loses the focus.

    Declaration
    public TimePickerBuilder Blur(string blur)
    Parameters
    Type Name Description
    System.String blur
    Returns
    Type Description
    TimePickerBuilder

    Change(String)

    Triggers when the value is changed.

    Declaration
    public TimePickerBuilder Change(string change)
    Parameters
    Type Name Description
    System.String change
    Returns
    Type Description
    TimePickerBuilder

    Cleared(String)

    Triggers when timepicker value is cleared using clear button.

    Declaration
    public TimePickerBuilder Cleared(string cleared)
    Parameters
    Type Name Description
    System.String cleared
    Returns
    Type Description
    TimePickerBuilder

    Close(String)

    Triggers when the popup is closed.

    Declaration
    public TimePickerBuilder Close(string close)
    Parameters
    Type Name Description
    System.String close
    Returns
    Type Description
    TimePickerBuilder

    Created(String)

    Triggers when the component is created.

    Declaration
    public TimePickerBuilder Created(string created)
    Parameters
    Type Name Description
    System.String created
    Returns
    Type Description
    TimePickerBuilder

    CssClass(String)

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

    Declaration
    public TimePickerBuilder CssClass(string cssClass)
    Parameters
    Type Name Description
    System.String cssClass
    Returns
    Type Description
    TimePickerBuilder

    Destroyed(String)

    Triggers when the component is destroyed.

    Declaration
    public TimePickerBuilder Destroyed(string destroyed)
    Parameters
    Type Name Description
    System.String destroyed
    Returns
    Type Description
    TimePickerBuilder

    Enabled(Boolean)

    Specifies whether the component to be disabled or not.

    Declaration
    public TimePickerBuilder Enabled(bool enabled = true)
    Parameters
    Type Name Description
    System.Boolean enabled
    Returns
    Type Description
    TimePickerBuilder

    EnableMask(Boolean)

    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 TimePickerBuilder EnableMask(bool enableMask = true)
    Parameters
    Type Name Description
    System.Boolean enableMask
    Returns
    Type Description
    TimePickerBuilder

    EnablePersistence(Boolean)

    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 TimePickerBuilder EnablePersistence(bool enablePersistence = true)
    Parameters
    Type Name Description
    System.Boolean enablePersistence
    Returns
    Type Description
    TimePickerBuilder

    EnableRtl(Boolean)

    Enable or disable rendering component in right to left direction.

    Declaration
    public TimePickerBuilder EnableRtl(bool enableRtl = true)
    Parameters
    Type Name Description
    System.Boolean enableRtl
    Returns
    Type Description
    TimePickerBuilder

    FloatLabelType(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 TimePickerBuilder FloatLabelType(FloatLabelType floatLabelType)
    Parameters
    Type Name Description
    FloatLabelType floatLabelType
    Returns
    Type Description
    TimePickerBuilder

    Focus(String)

    Triggers when the control gets focused.

    Declaration
    public TimePickerBuilder Focus(string focus)
    Parameters
    Type Name Description
    System.String focus
    Returns
    Type Description
    TimePickerBuilder

    Format(String)

    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 TimePickerBuilder Format(string format)
    Parameters
    Type Name Description
    System.String format
    Returns
    Type Description
    TimePickerBuilder

    HtmlAttributes(Object)

    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 TimePickerBuilder HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    TimePickerBuilder

    ItemRender(String)

    Triggers while rendering the each popup list item.

    Declaration
    public TimePickerBuilder ItemRender(string itemRender)
    Parameters
    Type Name Description
    System.String itemRender
    Returns
    Type Description
    TimePickerBuilder

    KeyConfigs(Object)

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

    Declaration
    public TimePickerBuilder KeyConfigs(object keyConfigs)
    Parameters
    Type Name Description
    System.Object keyConfigs
    Returns
    Type Description
    TimePickerBuilder

    Locale(String)

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

    Declaration
    public TimePickerBuilder Locale(string locale)
    Parameters
    Type Name Description
    System.String locale
    Returns
    Type Description
    TimePickerBuilder

    MaskPlaceholder(TimePickerMaskPlaceholder)

    Specifies the mask placeholder to be displayed on masked timepicker.

    Declaration
    public TimePickerBuilder MaskPlaceholder(TimePickerMaskPlaceholder maskPlaceholder)
    Parameters
    Type Name Description
    TimePickerMaskPlaceholder maskPlaceholder
    Returns
    Type Description
    TimePickerBuilder

    MaskPlaceholder(Action<TimePickerMaskPlaceholderBuilder>)

    Declaration
    public TimePickerBuilder MaskPlaceholder(Action<TimePickerMaskPlaceholderBuilder> maskPlaceholder)
    Parameters
    Type Name Description
    System.Action<TimePickerMaskPlaceholderBuilder> maskPlaceholder
    Returns
    Type Description
    TimePickerBuilder

    Max(Object)

    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 TimePickerBuilder Max(object max)
    Parameters
    Type Name Description
    System.Object max
    Returns
    Type Description
    TimePickerBuilder

    Min(Object)

    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 TimePickerBuilder Min(object min)
    Parameters
    Type Name Description
    System.Object min
    Returns
    Type Description
    TimePickerBuilder

    Open(String)

    Triggers when the popup is opened.

    Declaration
    public TimePickerBuilder Open(string open)
    Parameters
    Type Name Description
    System.String open
    Returns
    Type Description
    TimePickerBuilder

    OpenOnFocus(Boolean)

    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 TimePickerBuilder OpenOnFocus(bool openOnFocus = true)
    Parameters
    Type Name Description
    System.Boolean openOnFocus
    Returns
    Type Description
    TimePickerBuilder

    Placeholder(String)

    Specifies the placeholder text that is displayed in textbox.

    Declaration
    public TimePickerBuilder Placeholder(string placeholder)
    Parameters
    Type Name Description
    System.String placeholder
    Returns
    Type Description
    TimePickerBuilder

    Readonly(Boolean)

    Declaration
    public TimePickerBuilder Readonly(bool readOnly = true)
    Parameters
    Type Name Description
    System.Boolean readOnly
    Returns
    Type Description
    TimePickerBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    System.Web.HtmlString

    ScrollTo(Object)

    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 TimePickerBuilder ScrollTo(object scrollTo)
    Parameters
    Type Name Description
    System.Object scrollTo
    Returns
    Type Description
    TimePickerBuilder

    ShowClearButton(Boolean)

    Specifies whether to show or hide the clear icon.

    Declaration
    public TimePickerBuilder ShowClearButton(bool showClearButton = true)
    Parameters
    Type Name Description
    System.Boolean showClearButton
    Returns
    Type Description
    TimePickerBuilder

    Step(Double)

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

    For more details refer to Formatdocumentation.

    Declaration
    public TimePickerBuilder Step(double step)
    Parameters
    Type Name Description
    System.Double step
    Returns
    Type Description
    TimePickerBuilder

    StrictMode(Boolean)

    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 TimePickerBuilder StrictMode(bool strictMode = true)
    Parameters
    Type Name Description
    System.Boolean strictMode
    Returns
    Type Description
    TimePickerBuilder

    Value(Object)

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

    Declaration
    public TimePickerBuilder Value(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    TimePickerBuilder

    Width(Double)

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

    Declaration
    public TimePickerBuilder Width(double width)
    Parameters
    Type Name Description
    System.Double width
    Returns
    Type Description
    TimePickerBuilder

    Width(String)

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

    Declaration
    public TimePickerBuilder Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    TimePickerBuilder

    ZIndex(Int32)

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

    Declaration
    public TimePickerBuilder ZIndex(int zIndex)
    Parameters
    Type Name Description
    System.Int32 zIndex
    Returns
    Type Description
    TimePickerBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved