Angular DateRangeBox API
DateRangeBox is a UI component that allows a user to select a date range (pick or enter start and end dates).
Configuration
Name | Description |
---|---|
acceptCustomValue |
Specifies whether or not the UI component allows an end user to enter a custom value. |
accessKey |
Specifies the shortcut key that sets focus on the UI component. |
activeStateEnabled |
Specifies whether the UI component changes its visual state as a result of user interaction. |
applyButtonText |
Specifies the Apply button's text. |
applyValueMode |
Specifies the way an end user applies the selected value. |
buttons |
Allows you to add custom buttons to the input text field. |
calendarOptions |
Configures the calendar's value picker. |
cancelButtonText |
Specifies the Cancel button's text. |
dateSerializationFormat |
Specifies the date value serialization format. |
deferRendering |
Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately. |
disabled |
Specifies whether the UI component responds to user interaction. |
disableOutOfRangeSelection |
Specifies whether the UI component disables date selection before the start date and after the end date. |
displayFormat |
Specifies the date's display format. |
dropDownButtonComponent |
An alias for the dropDownButtonTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
dropDownButtonRender |
An alias for the dropDownButtonTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
dropDownButtonTemplate |
Specifies a custom template for the drop-down button. |
dropDownOptions |
Configures the drop-down that holds the content. |
elementAttr |
Specifies the global attributes to be attached to the UI component's container element. |
endDate |
Specifies the range's end date. |
endDateInputAttr |
Specifies the attributes passed to the end date input field. |
endDateLabel |
Specifies the label of the end date input field. |
endDateName |
Specifies the name attribute of the end date input field. |
endDateOutOfRangeMessage |
Specifies the message displayed if the specified end date is later than the max value or earlier than the min value. |
endDatePlaceholder |
Specifies a placeholder for the end date input field. |
endDateText |
Returns the text displayed by the end date input field. |
focusStateEnabled |
Specifies whether the UI component can be focused using keyboard navigation. |
height |
Specifies the UI component's height. |
hint |
Specifies text for a hint that appears when a user pauses on the UI component. |
hoverStateEnabled |
Specifies whether the UI component changes its state when a user pauses on it. |
invalidEndDateMessage |
Specifies a message for invalid end date input. |
invalidStartDateMessage |
Specifies a message for invalid start date input. |
isDirty |
Specifies whether the component's current value differs from the initial value. |
isValid |
Specifies or indicates whether the editor's value is valid. |
labelMode |
Specifies the label's display mode. |
max |
The latest date that can be selected in the UI component. |
min |
The earliest date that can be selected in the UI component. |
multiView |
Specifies whether the UI component displays a single-month calendar or a multi-month calendar. |
onChange |
A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard. |
onClosed |
A function that is executed once the drop-down editor is closed. |
onContentReady |
A function that is executed when the UI component is rendered and each time the component is repainted. |
onCopy |
A function that is executed when the UI component's input has been copied. |
onCut |
A function that is executed when the UI component's input has been cut. |
onDisposing |
A function that is executed before the UI component is disposed of. |
onEnterKey |
A function that is executed when the Enter key has been pressed while the UI component is focused. |
onFocusIn |
A function that is executed when the UI component gets focus. |
onFocusOut |
A function that is executed when the UI component loses focus. |
onInitialized |
A function used in JavaScript frameworks to save the UI component instance. |
onInput |
A function that is executed each time the UI component's input is changed while the UI component is focused. |
onKeyDown |
A function that is executed when a user is pressing a key on the keyboard. |
onKeyUp |
A function that is executed when a user releases a key on the keyboard. |
onOpened |
A function that is executed once the drop-down editor is opened. |
onOptionChanged |
A function that is executed after a UI component property is changed. |
onPaste |
A function that is executed when the UI component's input has been pasted. |
onValueChanged |
A function that is executed after the UI component's value is changed. |
opened |
Specifies whether or not the drop-down editor is displayed. |
openOnFieldClick |
Specifies whether a user can open the popup calendar by clicking an input field. |
readOnly |
Specifies whether the editor is read-only. |
rtlEnabled |
Switches the UI component to a right-to-left representation. |
showClearButton |
Specifies whether to display the Clear button in the UI component. |
showDropDownButton |
Specifies whether the drop-down button is visible. |
spellcheck |
Specifies whether or not the UI component checks the inner text for spelling mistakes. |
startDate |
Specifies the start date of date range. |
startDateInputAttr |
Specifies the attributes passed to the start date input field. |
startDateLabel |
Specifies a label of the start date input field. |
startDateName |
Specifies the name attribute of the start date input field. |
startDateOutOfRangeMessage |
Specifies the message displayed if the specified start date is later than the max value or earlier than the min value. |
startDatePlaceholder |
Specifies a placeholder for the start date input field. |
startDateText |
Returns the text displayed by the start date input field. |
stylingMode |
Specifies how the UI component's text field is styled. |
tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
todayButtonText |
Specified the Today button's text. |
useMaskBehavior |
Specifies whether to use an input mask based on the displayFormat property. |
validationError |
Information on the broken validation rule. Contains the first item from the validationErrors array. |
validationErrors |
An array of the validation rules that failed. |
validationMessageMode |
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. |
validationMessagePosition |
Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy. |
validationStatus |
Indicates or specifies the current validation status. |
value |
An array that specifies the selected range (start and end dates). |
valueChangeEvent |
Specifies the DOM events after which the UI component's value should be updated. |
visible |
Specifies whether the UI component is visible. |
width |
Specifies the UI component's width. |
See Also
Methods
Name | Description |
---|---|
beginUpdate() |
Postpones rendering that can negatively affect performance until the endUpdate() method is called. |
blur() |
Removes focus from the input element. |
clear() |
Resets the value property to the default value. |
close() |
Closes the drop-down editor. |
content() |
Gets the popup window's content. |
defaultOptions(rule) |
Specifies the device-dependent default configuration properties for this component. |
dispose() |
Disposes of all the resources allocated to the DateRangeBox instance. |
element() |
Gets the root UI component element. |
endDateField() |
Gets the |
endUpdate() |
Refreshes the UI component after a call of the beginUpdate() method. |
focus() |
Sets focus to the input element representing the UI component. |
getButton(name) |
Gets an instance of a custom action button. |
getInstance(element) |
Gets the instance of a UI component found using its DOM node. |
instance() |
Gets the UI component's instance. Use it to access other methods of the UI component. |
off(eventName) |
Detaches all event handlers from a single event. |
off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
on(eventName, eventHandler) |
Subscribes to an event. |
on(events) |
Subscribes to events. |
open() |
Opens the drop-down editor. |
option() |
Gets all UI component properties. |
option(optionName) |
Gets the value of a single property. |
option(optionName, optionValue) |
Updates the value of a single property. |
option(options) |
Updates the values of several properties. |
registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
repaint() |
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. |
reset() |
Resets the value property to the initial value. |
reset(value) |
Resets the value property to the value passed as an argument. |
resetOption(optionName) |
Resets a property to its default value. |
startDateField() |
Gets the |
Events
Name | Description |
---|---|
change |
Raised when the UI component loses focus after the text field's content was changed using the keyboard. |
closed |
Raised once the drop-down editor is closed. |
contentReady |
Raised when the UI component is rendered and each time the component is repainted. |
copy |
Raised when the UI component's input has been copied. |
cut |
Raised when the UI component's input has been cut. |
disposing |
Raised before the UI component is disposed of. |
enterKey |
Raised when the Enter key has been pressed while the UI component is focused. |
focusIn |
Raised when the UI component gets focus. |
focusOut |
Raised when the UI component loses focus. |
initialized |
Raised only once, after the UI component is initialized. |
input |
Raised each time the UI component's input is changed while the UI component is focused. |
keyDown |
Raised when a user is pressing a key on the keyboard. |
keyUp |
Raised when a user releases a key on the keyboard. |
opened |
Raised once the drop-down editor is opened. |
optionChanged |
Raised after a UI component property is changed. |
paste |
Raised when the UI component's input has been pasted. |
valueChanged |
Raised after the UI component's value is changed. |
Types
Name | Description |
---|---|
ChangeEvent |
The type of the change event handler's argument. |
ClosedEvent |
The type of the closed event handler's argument. |
ContentReadyEvent |
The type of the contentReady event handler's argument. |
CopyEvent |
The type of the copy event handler's argument. |
CutEvent |
The type of the cut event handler's argument. |
DisposingEvent |
The type of the disposing event handler's argument. |
DropDownPredefinedButton |
Specifies a custom button for an input text field. |
EnterKeyEvent |
The type of the enterKey event handler's argument. |
FocusInEvent |
The type of the focusIn event handler's argument. |
FocusOutEvent |
The type of the focusOut event handler's argument. |
InitializedEvent |
The type of the initialized event handler's argument. |
InputEvent |
The type of the input event handler's argument. |
KeyDownEvent |
The type of the keyDown event handler's argument. |
KeyUpEvent |
The type of the keyUp event handler's argument. |
OpenedEvent |
The type of the opened event handler's argument. |
OptionChangedEvent |
The type of the optionChanged event handler's argument. |
PasteEvent |
The type of the paste event handler's argument. |
TextBoxType |
Specifies the text box type. |
ValueChangedEvent |
The type of the valueChanged event handler's argument. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.