The InputDateRange control extends the InputDate control and sets the selectionMode property to Range, the monthCount property to **2**, and the showMonthPicker property to **ShowMonthPicker.Outside**.
Use the value and rangeEnd properties to access the currently selected date range.
Use the predefinedRanges property to add pre-defined ranges that users can select from.
constructor(element: any, options?: any): InputDateRange
Initializes a new instance of the InputDateRange class.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
The JavaScript object containing initialization data for the control.
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.
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**.
Gets a reference to the Calendar control shown in the drop-down box.
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.
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**.
Gets or sets the template used to instantiate DropDown controls.
Gets the drop down element shown when the isDroppedDown property is set to true.
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.
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).
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.
Gets the DOM element that is hosting the control.
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:
// 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')
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 "tel" or "text"
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**.
Gets or sets a value that determines whether the control is disabled.
Disabled controls cannot get mouse or keyboard events.
Gets or sets a value that indicates whether the drop down is currently visible.
The default value for this property is **false**.
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**.
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.
Gets a value that indicates whether the control is currently handling a touch event.
Gets a value that indicates whether the control is currently being updated.
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:
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' : '';
}
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;
}
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.
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.
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.
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:
import { InputDate } from '@mescius/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); } ```
Gets or sets the string shown as a hint when the control is empty.
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:
import { DateTime } from '@mescius/wijmo';
import { InputDate } from '@mescius/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
};
}
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.
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.
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.
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**.
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
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 '@mescius/wijmo.input';
var inputDate = new InputDate('#el, {
selectionMode: 'Month',
format: 'MMM yyyy'
});
The default value for this property is **DateSelectionMode.Day**.
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 **' - '**.
Gets or sets a value that indicates whether the control should display a drop-down button.
The default value for this property is **true**.
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**.
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**.
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**.
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.
Gets or sets the currently selected date.
The default value for this property is the current date.
Gets or sets the number of weeks to show on the calendar after the current month.
The default value for this property is **zero**.
Gets or sets the number of weeks to show on the calendar before the current month.
The default value for this property is **zero**.
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.
Target element for the event.
String that specifies the event.
Function to execute when the event occurs.
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().
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. Therefore, this method is not available. 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');
```
Names of classes to add to the control's host element.
An HTML string that defines the control template.
A dictionary of part variables and their names.
Name of the part to be named after the host element. This determines how the control submits data when used in forms.
beginUpdate(): void
Suspends notifications until the next call to endUpdate.
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.
Function to be executed.
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.
disposeAll(e?: HTMLElement): void
Disposes of all Wijmo controls contained in an HTML element.
Container element.
endUpdate(): void
Resumes notifications suspended by calls to beginUpdate.
getControl(element: any): Control
Gets the control that is hosted in a given DOM element.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
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).
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.
Object that contains the initialization data.
invalidate(fullUpdate?: boolean): void
Invalidates the control causing an asynchronous refresh.
Whether to update the control layout as well as the content.
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.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
onGotFocus(e?: EventArgs): void
Raises the gotFocus event.
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.
onIsDroppedDownChanged(e?: EventArgs): void
Raises the isDroppedDownChanged event.
onIsDroppedDownChanging(e: CancelEventArgs): boolean
Raises the isDroppedDownChanging event.
onLostFocus(e?: EventArgs): void
Raises the lostFocus event.
onRangeChanged(e?: EventArgs): void
Raises the rangeChanged event.
onRangeEndChanged(e?: EventArgs): void
Raises the rangeEndChanged event.
onRefreshed(e?: EventArgs): void
Raises the refreshed event.
onRefreshing(e?: EventArgs): void
Raises the refreshing event.
onTextChanged(e?: EventArgs): void
Raises the textChanged event.
onValueChanged(e?: EventArgs): void
Raises the valueChanged event.
refresh(fullUpdate?: boolean): void
Refreshes the control.
Whether to update the control layout as well as the content.
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.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
Removes one or more event listeners attached to elements owned by this Control.
Target element for the event. If null, removes listeners attached to all targets.
String that specifies the event. If null, removes listeners attached to all events.
Handler to remove. If null, removes all handlers.
Whether the listener is capturing. If null, removes capturing and non-capturing listeners.
selectAll(): void
Sets the focus to the control and selects all its content.
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.
Occurs after the drop down is shown or hidden.
Occurs before the drop down is shown or hidden.
Occurs when the value of the rangeEnd property changes into a non-null value, indicating a data range has been selected.
Occurs when the value of the rangeEnd property changes.
Occurs after the control has refreshed its contents.
Occurs when the control is about to refresh its contents.
Occurs when the value of the text property changes.