ASP.NET MVC Controls | ComponentOne
In This Topic
    InputDate Class
    In This Topic
    File
    wijmo.input.js
    Module
    wijmo.input
    Base Class
    DropDown
    Derived Classes
    InputDateRange, InputDateTime

    The InputDate control allows users to type in dates using any format supported by the Globalize class, or to pick dates from a drop-down that contains a Calendar control.

    Use the min and max properties to restrict the range of values that the user can enter.

    For details about using the min and max properties, please see the Using the min and max properties topic.

    Use the value property to get or set the currently selected date.

    Use the autoExpandSelection property to determine whether the control should automatically expand the selection to entire words, numbers, or dates when the user clicks the input element.

    The example below shows how to edit a **Date** value using an InputDate control.

    {@sample Input/InputDate/Overview/purejs Example}

    The InputDate and Calendar controls have built-in accessibility support. They support keyboard commands and provide aria-label attributes for all elements on the calendar. You can improve accessibility by adding your own application-specific aria-label attributes to the main input element of your InputDate controls. For example: ```typescript // create an InputDate control and add an aria-label for improved accessibility let inputDate = new InputDate('#theInputDate'); inputDate.inputElement.setAttribute('aria-label', 'enter trip start date in the format month/day/year') ```

    Constructor

    Properties

    Methods

    Events

    Constructor

    constructor

    constructor(element: any, options?: any): InputDate
    

    Initializes a new instance of the InputDate class.

    Parameters
    • element: any

      The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').

    • options: any
    Optional

    The JavaScript object containing initialization data for the control.

    Returns
    InputDate

    Properties

    alwaysShowCalendar

    Gets or sets a value that determines whether the calendar should remain visible in the dropdown even when there are selected predefined ranges.

    The default value for this property is **false**, which causes the control to hide the calendar if one of the predefined ranges is selected.

    Type
    boolean

    autoExpandSelection

    Gets or sets a value that indicates whether the control should automatically expand the selection to whole words/numbers when the control is clicked.

    The default value for this property is **true**.

    Inherited From
    DropDown
    Type
    boolean

    calendar

    Gets a reference to the Calendar control shown in the drop-down box.

    Type
    Calendar

    clickAction

    Gets or sets a value that specifies the action to perform when the user clicks the input element in the control.

    For most drop-down controls, this property is set to Select by default. This setting allows users to select portions of the text with the mouse.

    For drop-down controls that display non-editable text (such as the MultiSelect), this property is set to Toggle by default.

    Inherited From
    DropDown
    Type
    ClickAction

    closeOnSelection

    Gets or sets a value that determines whether the control should automatically close the drop-down when the user makes a selection.

    The default value for this property is **true**.

    Type
    boolean

     

    Static controlTemplate

    Gets or sets the template used to instantiate DropDown controls.

    Inherited From
    DropDown
    Type
    any

    format

    Gets or sets the format used to display the selected date.

    The format string is expressed as a .NET-style Date format string.

    The default value for this property is **'d'**, the culture-dependent short date pattern (e.g. 6/15/2020 in the US, 15/6/2020 in France, or 2020/6/15 in Japan).

    Type
    string

    handleWheel

    Gets or sets a value that determines whether the user can edit the current value using the mouse wheel.

    The default value for this property is **true**.

    Setting this property to **false** also disables the custom wheel handling for the control's drop-down calendar.

    Type
    boolean

    hostElement

    Gets the DOM element that is hosting the control.

    Inherited From
    Control
    Type
    HTMLElement

    inputElement

    Gets the HTML input element hosted by the control.

    Use this property in situations where you want to customize the attributes of the input element.

    For example, the code below uses the inputElement property to improve accessibility by adding an aria-label attribute to the control's input element: ```typescript // create an InputDate control and add an aria-label for improved accessibility let inputDate = new InputDate('#theInputDate'); inputDate.inputElement.setAttribute('aria-label', 'enter trip start date in the format month/day/year') ```

    Type
    HTMLInputElement

    inputType

    Gets or sets the "type" attribute of the HTML input element hosted by the control.

    Use this property to change the default setting if the default does not work well for the current culture, device, or application. In those cases, try changing the value to "number" or "text."

    Note that input elements with type "number" prevent selection in Chrome and therefore is not recommended. For more details, see this link: https://stackoverflow.com/questions/21177489/selectionstart-selectionend-on-input-type-number-no-longer-allowed-in-chrome

    Type
    string

    isAnimated

    Gets or sets a value that indicates whether the control should use a fade-in animation when displaying the drop-down.

    The default value for this property is **false**.

    Inherited From
    DropDown
    Type
    boolean

    isDisabled

    Gets or sets a value that determines whether the control is disabled.

    Disabled controls cannot get mouse or keyboard events.

    Inherited From
    Control
    Type
    boolean

    isDroppedDown

    Gets or sets a value that indicates whether the drop down is currently visible.

    The default value for this property is **false**.

    Inherited From
    DropDown
    Type
    boolean

    isReadOnly

    Gets or sets a value that indicates whether the user can modify the control value using the mouse and keyboard.

    The default value for this property is **false**.

    Inherited From
    DropDown
    Type
    boolean

    isRequired

    Gets or sets a value that determines whether the control value must be set to a non-null value or whether it can be set to null (by deleting the content of the control).

    This property defaults to true for most controls, including ComboBox, InputDate, InputTime, InputDateTime, and InputColor. It defaults to false for the AutoComplete control.

    Inherited From
    DropDown
    Type
    boolean

    isTouching

    Gets a value that indicates whether the control is currently handling a touch event.

    Inherited From
    Control
    Type
    boolean

    isUpdating

    Gets a value that indicates whether the control is currently being updated.

    Inherited From
    Control
    Type
    boolean

    itemFormatter

    Gets or sets a formatter function to customize dates in the drop-down calendar.

    The formatter function can add any content to any date. It allows complete customization of the appearance and behavior of the calendar.

    If specified, the function takes two parameters:

    • the date being formatted
    • the HTML element that represents the date

    For example, the code below shows weekends with a yellow background:

    ```typescript inputDate.itemFormatter = (date, element) => { const day = date.getDay(); element.style.backgroundColor = day == 0 || day == 6 ? 'yellow' : ''; } ```

    Type
    IDateFormatter

    itemValidator

    Gets or sets a validator function to determine whether dates are valid for selection.

    If specified, the validator function should take one parameter representing the date to be tested, and should return false if the date is invalid and should not be selectable.

    For example, the code below prevents users from selecting dates that fall on weekends:

    ```typescript inputDate.itemValidator = date => { const weekday = date.getDay(); return weekday != 0 && weekday != 6; } ```

    Type
    IDateValidator

    mask

    Gets or sets a mask to use while editing.

    The mask format is the same one that the InputMask control uses.

    If specified, the mask must be compatible with the value of the format and separator properties.

    For example, the mask '99/99/9999 - 99/99/9999' can be used for entering date ranges formatted as 'MM/dd/yyyy' with a ' - ' separator.

    Type
    string

    max

    Gets or sets the latest date that the user can enter.

    The default value for this property is **null**, which means no latest date is defined.

    For details about using the min and max properties, please see the Using the min and max properties topic.

    Type
    Date

    min

    Gets or sets the earliest date that the user can enter.

    The default value for this property is **null**, which means no earliest date is defined.

    For details about using the min and max properties, please see the Using the min and max properties topic.

    Type
    Date

    monthCount

    Gets or sets the number of months to display in the drop-down calendar.

    The default value for this property is **1**.

    For more details on this property, please see the monthCount property.

    When showing multiple months in the same calendar, months will be shown using a wrapping flex-box container. You may use CSS to limit the number of months shown per row in the drop-down.

    For example this code creates an InputDate control with a drop-down that shows three months per row: ```typescript import { InputDate } from '@grapecity/wijmo.input'; let idt = new InputDate(document.createElement('#theInputDate'), { monthCount: 6, dropDownCssClass: 'three-months-per-row' }); ``` ``` .three-months-per-row .wj-calendar-multimonth { width: calc(3 * 21em); } ```

    Type
    number

    placeholder

    Gets or sets the string shown as a hint when the control is empty.

    Inherited From
    DropDown
    Type
    string

    predefinedRanges

    Gets or sets an object that defines predefined ranges.

    This property is useful only when the selectionMode property is set to Range.

    Each property in the object represents a predefined range, identified by the property name and defined by an array with two dates (range start and end).

    Properties with null values represent custom ranges to be defined by users by clicking on the calendar.

    For example: ```typescript import { DateTime } from '@grapecity/wijmo'; import { InputDate } from '@grapecity/wijmo.input';

    new InputDate(host, { selectionMode: 'Range', predefinedRanges: getRanges() });

    function getRanges() { let dt = DateTime, now = new Date(); return { 'This Week': [dt.weekFirst(now), dt.weekLast(now)], 'Last Week': [dt.weekFirst(dt.addDays(now, -7)), dt.weekLast(dt.addDays(now, -7))], 'Next Week': [dt.weekFirst(dt.addDays(now, +7)), dt.weekLast(dt.addDays(now, +7))],

    'This Month': [dt.monthFirst(now), dt.monthLast(now)], 'Last Month': [dt.monthFirst(dt.addMonths(now, -1)), dt.monthLast(dt.addMonths(now, -1))], 'Next Month': [dt.monthFirst(dt.addMonths(now, +1)), dt.monthLast(dt.addMonths(now, +1))], 'Custom Range': null }; } ```

    Type
    any

    rangeEnd

    Gets or sets the last selected date in a range selection.

    To enable date range selection, set the selectionMode property to **DateSelectionMode.Range**.

    Once you do that, the selection range will be defined by the value and rangeEnd properties.

    Type
    Date

    rangeMax

    Gets or sets the maximum length allowed when editing date ranges.

    This property is used only when the selectionMode property is set to Range.

    The default value for this property is **0**, which means there is no maximum value for range lengths.

    Type
    number

    rangeMin

    Gets or sets the minimum number of days allowed when editing date ranges.

    This property is used only when the selectionMode property is set to Range.

    The default value for this property is **0**, which means there is no minimum value for range lengths.

    Type
    number

    repeatButtons

    Gets or sets a value that determines whether the calendar buttons should act as repeat buttons, firing repeatedly as the button remains pressed.

    The default value for this property is **true**.

    Type
    boolean

    rightToLeft

    Gets a value indicating whether the control is hosted in an element with right-to-left layout.

    Inherited From
    Control
    Type
    boolean

    selectionMode

    Gets or sets a value that determines whether users can select days, ranges, months, or no values at all.

    This property affects the behavior of the drop-down calendar, but not the format used to display dates. If you set selectionMode to 'Month', you should normally set the format property to 'MMM yyyy' or some format that does not include the day. For example:

    ```typescript import { InputDate } from '@grapecity/wijmo.input'; var inputDate = new InputDate('#el, { selectionMode: 'Month', format: 'MMM yyyy' }); ```

    The default value for this property is **DateSelectionMode.Day**.

    Type
    DateSelectionMode

    separator

    Gets or sets a string used as a separator between the value and rangeEnd values shown by the control.

    This property is used only when the selectionMode property is set to Range.

    The default value for this property is a **' - '**.

    Type
    string

    showDropDownButton

    Gets or sets a value that indicates whether the control should display a drop-down button.

    The default value for this property is **true**.

    Inherited From
    DropDown
    Type
    boolean

    showHeader

    Gets or sets a value that determines whether the calendar should display an area with the current month and navigation buttons.

    The default value for this property is **true**.

    Type
    boolean

    showMonthPicker

    Gets or sets a value that determines whether the calendar should display a list of months when the user clicks the header element on the month calendar.

    The default value for this property is **ShowMonthPicker.First**.

    Type
    boolean

    showYearPicker

    Gets or sets a value that determines whether the drop-down calendar should display a list of years when the user clicks the header element on the year calendar.

    The default value for this property is **true**.

    Type
    boolean

    tabOrder

    Gets or sets a value of the **tabindex** attribute associated with the control.

    **tabindex** attribute value can be defined statically for a Wijmo control by specifying it on the control's host HTML element. But this value can't be changed later during application lifecycle, because Wijmo controls have complex structure, and the control may need to propagate this attribute value to its internal element to work properly.

    Because of this, to read or change control's **tabindex** dynamically, you should do it using this property.

    Inherited From
    Control
    Type
    number

    text

    Gets or sets the text shown on the control.

    Type
    string

    value

    Gets or sets the currently selected date.

    The default value for this property is the current date.

    Type
    Date

    weeksAfter

    Gets or sets the number of weeks to show on the calendar after the current month.

    The default value for this property is **zero**.

    Type
    number

    weeksBefore

    Gets or sets the number of weeks to show on the calendar before the current month.

    The default value for this property is **zero**.

    Type
    number

    Methods

    addEventListener

    addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
    

    Adds an event listener to an element owned by this Control.

    The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener methods).

    Failing to remove event listeners may cause memory leaks.

    The passive parameter is set to false by default, which means the event handler may call event.preventDefault(). If you are adding passive handlers to touch or wheel events, setting this parameter to true will improve application performance.

    For details on passive event listeners, please see Improving scrolling performance with passive listeners.

    Parameters
    • target: EventTarget

      Target element for the event.

    • type: string

      String that specifies the event.

    • fn: any

      Function to execute when the event occurs.

    • capture: boolean
    Optional

    Whether the listener should be handled by the control before it is handled by the target element.

    Indicates that the handler will never call preventDefault().

    Inherited From
    Control
    Returns
    void

    applyTemplate

    applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
    

    Applies the template to a new instance of a control, and returns the root element.

    This method should be called by constructors of templated controls. It is responsible for binding the template parts to the corresponding control members.

    For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.

    ```typescript this.applyTemplate('wj-control wj-inputnumber', templateString, { _tbx: 'input', _btnUp: 'btn-inc', _btnDn: 'btn-dec' }, 'input'); ``````

    Parameters
    • classNames: string

      Names of classes to add to the control's host element.

    • template: string

      An HTML string that defines the control template.

    • parts: Object

      A dictionary of part variables and their names.

    • namePart: string Optional

      Name of the part to be named after the host element. This determines how the control submits data when used in forms.

    Inherited From
    Control
    Returns
    HTMLElement

    beginUpdate

    beginUpdate(): void
    

    Suspends notifications until the next call to endUpdate.

    Inherited From
    Control
    Returns
    void

    containsFocus

    containsFocus(): boolean
    

    Checks whether this control contains the focused element.

    Inherited From
    Control
    Returns
    boolean

    deferUpdate

    deferUpdate(fn: Function): void
    

    Executes a function within a beginUpdate/endUpdate block.

    The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.

    Parameters
    Inherited From
    Control
    Returns
    void

    dispose

    dispose(): void
    

    Disposes of the control by removing its association with the host element.

    The dispose method automatically removes any event listeners added with the addEventListener method.

    Calling the dispose method is important in applications that create and remove controls dynamically. Failing to dispose of the controls may cause memory leaks.

    Inherited From
    Control
    Returns
    void

    Static disposeAll

    disposeAll(e?: HTMLElement): void
    

    Disposes of all Wijmo controls contained in an HTML element.

    Parameters
    Inherited From
    Control
    Returns
    void

    endUpdate

    endUpdate(): void
    

    Resumes notifications suspended by calls to beginUpdate.

    Inherited From
    Control
    Returns
    void

    focus

    focus(): void
    

    Sets the focus to this control.

    Inherited From
    Control
    Returns
    void

    Static getControl

    getControl(element: any): Control
    

    Gets the control that is hosted in a given DOM element.

    Parameters
    • element: any

      The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').

    Inherited From
    Control
    Returns
    Control

    getTemplate

    getTemplate(): string
    

    Gets the HTML template used to create instances of the control.

    This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, which does not specify a template, it will override the template defined by the DropDown base class (the nearest ancestor that does specify a template).

    Inherited From
    Control
    Returns
    string

    initialize

    initialize(options: any): void
    

    Initializes the control by copying the properties from a given object.

    This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.

    For example:

    ```typescript grid.initialize({ itemsSource: myList, autoGenerateColumns: false, columns: [ { binding: 'id', header: 'Code', width: 130 }, { binding: 'name', header: 'Name', width: 60 } ] });

    // is equivalent to grid.itemsSource = myList; grid.autoGenerateColumns = false; // etc. ```

    The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.

    Parameters
    • options: any

      Object that contains the initialization data.

    Inherited From
    Control
    Returns
    void

    invalidate

    invalidate(fullUpdate?: boolean): void
    

    Invalidates the control causing an asynchronous refresh.

    Parameters
    • fullUpdate: boolean Optional

      Whether to update the control layout as well as the content.

    Inherited From
    Control
    Returns
    void

    Static invalidateAll

    invalidateAll(e?: HTMLElement): void
    

    Invalidates all Wijmo controls contained in an HTML element.

    Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.

    If this happens, you must handle the appropriate event in the dynamic container and call the invalidateAll method so the contained Wijmo controls will update their layout information properly.

    Parameters
    • e: HTMLElement Optional

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Inherited From
    Control
    Returns
    void

    onGotFocus

    onGotFocus(e?: EventArgs): void
    

    Raises the gotFocus event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onInvalidInput

    onInvalidInput(e: CancelEventArgs): void
    

    Raises the invalidInput event.

    If the event handler cancels the event, the control will keep the invalid input and the focus.

    Parameters
    Inherited From
    Control
    Returns
    void

    onIsDroppedDownChanged

    onIsDroppedDownChanged(e?: EventArgs): void
    

    Raises the isDroppedDownChanged event.

    Parameters
    Inherited From
    DropDown
    Returns
    void

    onIsDroppedDownChanging

    onIsDroppedDownChanging(e: CancelEventArgs): boolean
    

    Raises the isDroppedDownChanging event.

    Parameters
    Inherited From
    DropDown
    Returns
    boolean

    onLostFocus

    onLostFocus(e?: EventArgs): void
    

    Raises the lostFocus event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onRangeChanged

    onRangeChanged(e?: EventArgs): void
    

    Raises the rangeChanged event.

    Parameters
    Returns
    void

    onRangeEndChanged

    onRangeEndChanged(e?: EventArgs): void
    

    Raises the rangeEndChanged event.

    Parameters
    Returns
    void

    onRefreshed

    onRefreshed(e?: EventArgs): void
    

    Raises the refreshed event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onRefreshing

    onRefreshing(e?: EventArgs): void
    

    Raises the refreshing event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onTextChanged

    onTextChanged(e?: EventArgs): void
    

    Raises the textChanged event.

    Parameters
    Inherited From
    DropDown
    Returns
    void

    onValueChanged

    onValueChanged(e?: EventArgs): void
    

    Raises the valueChanged event.

    Parameters
    Returns
    void

    refresh

    refresh(fullUpdate?: boolean): void
    

    Refreshes the control.

    Parameters
    • fullUpdate: boolean Optional

      Whether to update the control layout as well as the content.

    Inherited From
    Control
    Returns
    void

    Static refreshAll

    refreshAll(e?: HTMLElement): void
    

    Refreshes all Wijmo controls contained in an HTML element.

    This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.

    Parameters
    • e: HTMLElement Optional

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Inherited From
    Control
    Returns
    void

    removeEventListener

    removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
    

    Removes one or more event listeners attached to elements owned by this Control.

    Parameters
    • target: EventTarget Optional

      Target element for the event. If null, removes listeners attached to all targets.

    • type: string Optional

      String that specifies the event. If null, removes listeners attached to all events.

    • fn: any Optional

      Handler to remove. If null, removes all handlers.

    • capture: boolean Optional

      Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

    Inherited From
    Control
    Returns
    number

    selectAll

    selectAll(): void
    

    Sets the focus to the control and selects all its content.

    Inherited From
    DropDown
    Returns
    void

    Events

    gotFocus

    Occurs when the control gets the focus.

    Inherited From
    Control
    Arguments
    EventArgs

    invalidInput

    Occurs when invalid input is detected.

    Invalid input may occur when the user types or pastes a value that cannot be converted to the proper type, or a value that is outside the valid range.

    If the event handler cancels the event, the control will retain the invalid content and the focus, so users can correct the error.

    If the event is not canceled, the control will ignore the invalid input and will retain the original content.

    Inherited From
    Control
    Arguments
    CancelEventArgs

    isDroppedDownChanged

    Occurs after the drop down is shown or hidden.

    Inherited From
    DropDown
    Arguments
    EventArgs

    isDroppedDownChanging

    Occurs before the drop down is shown or hidden.

    Inherited From
    DropDown
    Arguments
    CancelEventArgs

    lostFocus

    Occurs when the control loses the focus.

    Inherited From
    Control
    Arguments
    EventArgs

    rangeChanged

    Occurs when the value of the rangeEnd property changes into a non-null value, indicating a data range has been selected.

    Arguments
    EventArgs

    rangeEndChanged

    Occurs when the value of the rangeEnd property changes.

    Arguments
    EventArgs

    refreshed

    Occurs after the control has refreshed its contents.

    Inherited From
    Control
    Arguments
    EventArgs

    refreshing

    Occurs when the control is about to refresh its contents.

    Inherited From
    Control
    Arguments
    EventArgs

    textChanged

    Occurs when the value of the text property changes.

    Inherited From
    DropDown
    Arguments
    EventArgs

    valueChanged

    Occurs when the value of the value property changes.

    Arguments
    EventArgs