5.20203.748
wijmo.angular2.input Class WjInputDate Wijmo API Class

WjInputDate Class

Angular 2 component for the wijmo.input.InputDate control.

Use the wj-input-date component to add InputDate controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.

The WjInputDate component is derived from the InputDate control and inherits all its properties, events and methods.

Heirarchy

Properties

alwaysShowCalendar

alwaysShowCalendar: boolean

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.

asyncBindings

asyncBindings: boolean

Allows you to override the global WjOptions.asyncBindings setting for this specific component. See the WjOptions.WjOptions.asyncBindings property description for details.

autoExpandSelection

autoExpandSelection: boolean

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.

calendar

calendar: Calendar

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

clickAction

clickAction: 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 ClickAction.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 ClickAction.Toggle by default.

closeOnSelection

closeOnSelection: boolean

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.

dropDown

dropDown: HTMLElement

Gets the drop down element shown when the isDroppedDown property is set to true.

dropDownCssClass

dropDownCssClass: string

Gets or sets a CSS class name to add to the control's drop-down element.

This property is useful when styling the drop-down element, because it is shown as a child of the document body rather than as a child of the control itself, which prevents using CSS selectors based on the parent control.

format

format: string

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).

gotFocusNg

gotFocusNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo gotFocus event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional gotFocus Wijmo event name.

hostElement

hostElement: HTMLElement

Gets the DOM element that is hosting the control.

initialized

initialized: EventEmitter<any>

This event is triggered after the component has been initialized by Angular, that is all bound properties have been assigned and child components (if any) have been initialized.

inputElement

inputElement: HTMLInputElement

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.

inputType

inputType: string

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

invalidInputNg

invalidInputNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo invalidInput event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional invalidInput Wijmo event name.

isAnimated

isAnimated: boolean

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.

isDisabled

isDisabled: boolean

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

Disabled controls cannot get mouse or keyboard events.

isDroppedDown

isDroppedDown: boolean

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

The default value for this property is false.

isDroppedDownChangedNg

isDroppedDownChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo isDroppedDownChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional isDroppedDownChanged Wijmo event name.

isDroppedDownChangingNg

isDroppedDownChangingNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo isDroppedDownChanging event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional isDroppedDownChanging Wijmo event name.

isInitialized

isInitialized: boolean

Indicates whether the component has been initialized by Angular. Changes its value from false to true right before triggering the initialized event.

isReadOnly

isReadOnly: boolean

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.

isRequired

isRequired: boolean

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.

isTouching

isTouching: boolean

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

isUpdating

isUpdating: boolean

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

itemFormatter

itemFormatter: IDateFormatter

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:

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

itemValidator

itemValidator: IDateValidator

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:

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

lostFocusNg

lostFocusNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo lostFocus event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional lostFocus Wijmo event name.

mask

mask: string

Gets or sets a mask to use while editing.

The mask format is the same one that the wijmo.input.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.

max

max: Date

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.

min

min: Date

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.

monthCount

monthCount: number

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

The default value for this property is 1.

placeholder

placeholder: string

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

predefinedRanges

predefinedRanges: any

Gets or sets an object that defines predefined ranges.

This property is useful only when the selectionMode property is set to DateSelectionMode.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:

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
    };
}

rangeEnd

rangeEnd: Date

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.

rangeEndChangedNg

rangeEndChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo rangeEndChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional rangeEndChanged Wijmo event name.

rangeMax

rangeMax: number

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

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

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

rangeMin

rangeMin: number

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 DateSelectionMode.Range.

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

refreshedNg

refreshedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo refreshed event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional refreshed Wijmo event name.

refreshingNg

refreshingNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo refreshing event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional refreshing Wijmo event name.

repeatButtons

repeatButtons: boolean

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.

rightToLeft

rightToLeft: boolean

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

selectionMode

selectionMode: DateSelectionMode

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:

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.

separator

separator: string

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 DateSelectionMode.Range.

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

showDropDownButton

showDropDownButton: boolean

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

The default value for this property is true.

showHeader

showHeader: boolean

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.

showMonthPicker

showMonthPicker: 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.

showYearPicker

showYearPicker: boolean

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.

text

text: string

Gets or sets the text shown on the control.

textChangedNg

textChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo textChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional textChanged Wijmo event name.

value

value: Date

Gets or sets the currently selected date.

The default value for this property is the current date.

valueChangedNg

valueChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo valueChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional valueChanged Wijmo event name.

weeksAfter

weeksAfter: number

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

The default value for this property is zero.

weeksBefore

weeksBefore: number

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

The default value for this property is zero.

wjModelProperty

wjModelProperty: string

Defines a name of a property represented by [(ngModel)] directive (if specified). Default value is 'value'.

Static controlTemplate

controlTemplate: string

Gets or sets the template used to instantiate DropDown controls.

Methods

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.

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

    @param classNames Names of classes to add to the control's host element. @param template An HTML string that defines the control template. @param parts A dictionary of part variables and their names. @param namePart Name of the part to be named after the host element. This determines how the control submits data when used in forms.

    Parameters

    • classNames: string
    • template: string
    • parts: Object
    • Optional namePart: string

    Returns HTMLElement

beginUpdate

  • beginUpdate(): void

created

  • created(): void
  • If you create a custom component inherited from a Wijmo component, you can override this method and perform necessary initializations that you usually do in a class constructor. This method is called in the last line of a Wijmo component constructor and allows you to not declare your custom component's constructor at all, thus preventing you from a necessity to maintain constructor parameters and keep them in synch with Wijmo component's constructor parameters.

    Returns void

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

    • fn: Function

      Function to be executed.

    Returns void

endUpdate

  • endUpdate(): void

focus

  • focus(): void
  • Sets the focus to this control.

    Returns void

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).

    Returns string

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean
  • Determines whether an object has a property with the specified name.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

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:

    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.

    Returns void

invalidate

  • invalidate(fullUpdate?: boolean): void
  • Invalidates the control causing an asynchronous refresh.

    Parameters

    • Optional fullUpdate: boolean

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

    Returns void

isPrototypeOf

  • isPrototypeOf(v: Object): boolean
  • Determines whether an object exists in another object's prototype chain.

    Parameters

    • v: Object

      Another object whose prototype chain is to be checked.

    Returns boolean

onInvalidInput

onRangeEndChanged

onRefreshed

onRefreshing

onTextChanged

onValueChanged

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean
  • Determines whether a specified property is enumerable.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

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

    • Optional target: EventTarget

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

    • Optional type: string

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

    • Optional fn: any

      Handler to remove. If null, removes all handlers.

    • Optional capture: boolean

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

    Returns number

    The number of listeners removed.

selectAll

  • selectAll(): void
  • Sets the focus to the control and selects all its content.

    Returns void

toLocaleString

  • toLocaleString(): string
  • Returns a date converted to a string using the current locale.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an object.

    Returns string

valueOf

  • valueOf(): Object
  • Returns the primitive value of the specified object.

    Returns Object

Static disposeAll

  • disposeAll(e?: HTMLElement): void
  • Disposes of all Wijmo controls contained in an HTML element.

    Parameters

    • Optional e: HTMLElement

      Container element.

    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').

    Returns Control

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 Control.invalidateAll method so the contained Wijmo controls will update their layout information properly.

    Parameters

    • Optional e: HTMLElement

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

    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

    • Optional e: HTMLElement

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

    Returns void

Events

gotFocus

gotFocus: Event<Control, EventArgs>

Occurs when the control gets the focus.

invalidInput

invalidInput: Event<Control, CancelEventArgs>

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.

isDroppedDownChanged

isDroppedDownChanged: Event<DropDown, EventArgs>

Occurs after the drop down is shown or hidden.

isDroppedDownChanging

isDroppedDownChanging: Event<DropDown, CancelEventArgs>

Occurs before the drop down is shown or hidden.

lostFocus

lostFocus: Event<Control, EventArgs>

Occurs when the control loses the focus.

rangeEndChanged

rangeEndChanged: Event<Calendar, EventArgs>

Occurs when the value of the rangeEnd property changes.

refreshed

refreshed: Event<Control, EventArgs>

Occurs after the control has refreshed its contents.

refreshing

refreshing: Event<Control, EventArgs>

Occurs when the control is about to refresh its contents.

textChanged

textChanged: Event<DropDown, EventArgs>

Occurs when the value of the text property changes.

valueChanged

valueChanged: Event<InputDate, EventArgs>

Occurs when the value of the value property changes.