Angular DateBox Properties
An object defining configuration options for the DateBox widget.
acceptCustomValue
Specifies whether or not the widget allows an end-user to enter a custom value.
accessKey
Specifies the shortcut key that sets focus on the widget.
The value of this option will be passed to the accesskey
attribute of the HTML element that underlies the widget.
activeStateEnabled
Specifies whether or not the widget changes its state when interacting with a user.
This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.
adaptivityEnabled
Specifies whether or not adaptive widget rendering is enabled on a small screen.
While displaying DateBox in your app, you may want to use different layouts for different screen sizes. While desktop monitors provide enough space, mobile screens do not. In this case, you can enable the widget to have a more compact representation. For this purpose, assign true to the adaptivityEnabled option. In the adaptive mode, the date box is displayed without the digital clock face.
applyValueMode
Specifies the way an end-user applies the selected value.
The option accepts the following values.
'useButtons'
Enables an end-user to apply the selected value or cancel the selection using the Apply and Cancel buttons respectively.'instantly'
Applies the selected value immediately after a user clicks the required value in the drop-down menu. This value cannot be applied if the pickerType is "rollers" or the type is "datetime".
When using the widget as an ASP.NET MVC Control, specify this option using the EditorApplyValueMode
enum. This enum accepts the following values: Instantly
and UseButtons
.
dateOutOfRangeMessage
Specifies the message displayed if the specified date is later than the max value or earlier than the min value.
dateSerializationFormat
Specifies the date-time value serialization format. Use it only if you do not specify the value at design time.
Without a value, the widget cannot detect its format. In this case, specify the dateSerializationFormat option that supports the following formats:
"yyyy-MM-dd"
- a local date"yyyy-MM-ddTHH:mm:ss"
- local date and time"yyyy-MM-ddTHH:mm:ssZ"
- the UTC date and time"yyyy-MM-ddTHH:mm:ssx"
- date and time with a timezone
This option applies only if the forceIsoDateParsing field is set to true in the global configuration object.
deferRendering
Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately.
disabledDates
Specifies dates to be disabled. Applies only if pickerType is "calendar".
true if the date should be disabled; otherwise false.
This option accepts an array of dates...
$(function () { $("#dateBoxContainer").dxDateBox({ // ... disabledDates: [ new Date("07/1/2017"), new Date("07/2/2017"), new Date("07/3/2017") ] }); });
... or a function that specifies whether the currently checked date is disabled.
$(function () { $("#dateBoxContainer").dxDateBox({ disabledDates: function (args) { var dayOfWeek = args.date.getDay(), month = args.date.getMonth(), isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 ), isMarch = (args.view === "year" || args.view === "month") && month === 2; if(isWeekend || isMarch) { return true; } } }); });
displayFormat
Specifies the date display format. Ignored if the pickerType option is 'native'
dropDownButtonTemplate
Specifies a custom template for the drop-down button.
elementAttr
Specifies the attributes to be attached to the widget's root element.
You can configure this option in an ASP.NET MVC Control as follows:
@(Html.DevExtreme().WidgetName() .ElementAttr("class", "class-name") // ===== or ===== .ElementAttr(new { @id = "elementId", @class = "class-name" }) // ===== or ===== .ElementAttr(new Dictionary<string, object>() { { "id", "elementId" }, { "class", "class-name" } }) )
@(Html.DevExtreme().WidgetName() _ .ElementAttr("class", "class-name") ' ===== or ===== .ElementAttr(New With { .id = "elementId", .class = "class-name" }) ' ===== or ===== .ElementAttr(New Dictionary(Of String, Object) From { { "id", "elementId" }, { "class", "class-name" } }) )
focusStateEnabled
Specifies whether the widget can be focused using keyboard navigation.
height
Specifies the widget's height.
This option accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
hint
Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled
Specifies whether the widget changes its state when a user pauses on it.
inputAttr
Specifies the attributes to be passed on to the underlying HTML element.
You can configure this option in an ASP.NET MVC Control as follows:
@(Html.DevExtreme().WidgetName() .InputAttr("id", "inputId") // ===== or ===== .InputAttr(new { @id = "inputId" }) // ===== or ===== .InputAttr(new Dictionary<string, object>() { { "id", "inputId" } }) )
@(Html.DevExtreme().WidgetName() _ .InputAttr("id", "inputId") ' ===== or ===== .InputAttr(New With { .id = "inputId" }) ' ===== or ===== .InputAttr(New Dictionary(Of String, Object) From { { "id", "inputId" } }) )
interval
Specifies the interval between neighboring values in the popup list in minutes.
invalidDateMessage
Specifies the message displayed if the typed value is not a valid date or time.
isValid
Specifies whether the editor's value is valid.
In Knockout apps, you may need to inform a user about an error that occurred during the validation of a view model field. For this purpose, set the editor's isValid option to the isValid value of the dxValidator that validates this field. To show an error message, set the editor's validationError option to the dxValidator's validationError value.
var editorValue = ko.observable("").extend({ dxValidator: { validationRules: [{ type: 'required', message: 'Specify this value' }] } }); var viewModel = { editorOptions: { value: editorValue, isValid: editorValue.dxValidator.isValid, validationError: editorValue.dxValidator.validationError } };
The editor's isValid and validationError options should also be specified when using a custom validation engine. In this instance, the validation result will be displayed for the editor by the means of the DevExtreme Validation UI.
See Also
max
The last date that can be selected within the widget.
See Also
maxLength
Specifies the maximum number of characters you can enter into the textbox.
If the number of entered characters reaches the value assigned to this option, the widget does not allow you to enter any more characters.
maxZoomLevel
Specifies the maximum zoom level of a calendar, which is used to pick the date.
The zoom level ascends from 'month' to 'century' ('month'->'year'->'decade'->'century').
The option makes sense only if the pickerType option is set to 'calendar'.
When using the widget as an ASP.NET MVC Control, specify this option using the CalendarZoomLevel
enum. This enum accepts the following values: Month
, Year
, Decade
and Century
.
min
The minimum date that can be selected within the widget.
See Also
minZoomLevel
Specifies the minimal zoom level of a calendar, which is used to pick the date.
The zoom level ascends from 'month' to 'century' ('month'->'year'->'decade'->'century').
The option makes sense only if the pickerType option is set to 'calendar'.
When using the widget as an ASP.NET MVC Control, specify this option using the CalendarZoomLevel
enum. This enum accepts the following values: Month
, Year
, Decade
and Century
.
name
The value to be assigned to the name
attribute of the underlying HTML element.
Specify this option if the widget lies within an HTML form that will be submitted.
If you configure the widget as an ASP.NET MVC Control, use this option to bind the widget to a model property. If this model property contains Data Annotation validation attributes, you get the client-side validation enabled by default.
onChange
A handler for the change event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action when a change within the widget's input element is committed by an end user.
onClosed
A handler for the closed event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
Assign a function to perform a custom action after a drop-down editor has been hidden.
onContentReady
A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only when using Knockout. |
onCopy
A handler for the copy event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action after the widget's input is copied.
onCut
A handler for the cut event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action after the widget's input is cut.
onDisposing
A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
onEnterKey
A handler for the enterKey event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action after the 'Enter' key is pressed within the widget's input element.
onFocusIn
A handler for the focusIn event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action after the widget's input is focused.
onFocusOut
A handler for the focusOut event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action after the widget's input element loses focus.
onInitialized
A handler for the initialized event. Executed only once, after the widget is initialized.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
You cannot access widget elements in this handler because it is executed before they are ready. Use the onContentReady handler instead.
onInput
A handler for the input event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action when a value within the widget's input element is changed by an end user.
onKeyDown
A handler for the keyDown event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action when a key is pressed down within the widget's input element.
onKeyPress
A handler for the keyPress event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action when the keypress DOM event is raised for the current input element.
onKeyUp
A handler for the keyUp event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action when a key is released within the widget's input element.
onOpened
A handler for the opened event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
Assign a function to perform a custom action when the drop-down editor is shown.
onOptionChanged
A handler for the optionChanged event. Executed after an option of the widget is changed.
Information about the event.
Name | Type | Description |
---|---|---|
name |
The option's short name. |
|
model |
The model data. Available only if you use Knockout. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
|
fullName |
The option's full name. |
|
value | any |
The option's new value. |
onPaste
A handler for the paste event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action after the widget's input is pasted.
onValueChanged
A handler for the valueChanged event.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
value |
The widget's new value. |
|
previousValue |
The widget's previous value. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
Assign a function to perform a custom action when the editor value changes.
pickerType
Specifies the type of the date/time picker.
This option accepts the following values.
"native"
The picker type depends on the current platform or web browser."calendar"
The date box uses the Calendar widget to pick data. This value applies only when the type option is set to "date" or "datetime"."rollers"
The widget uses rollers to pick the date and time."list"
The widget uses the list of time values to pick the time. This value applies only when the type option is set to "time".
When using the widget as an ASP.NET MVC Control, specify this option using the DateBoxPickerType
enum. This enum accepts the following values: Native
, Calendar
, Rollers
and List
.
placeholder
Specifies a placeholder for the input field.
If the pickerType is "rollers", the placeholder's text goes also to the date picker title.
readOnly
A Boolean value specifying whether or not the widget is read-only.
rtlEnabled
Switches the widget to a right-to-left representation.
When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
showClearButton
Specifies whether to display the Clear button in the widget.
The Clear button sets the widget value to null.
spellcheck
Specifies whether or not the widget checks the inner text for spelling mistakes.
tabIndex
Specifies the number of the element when the Tab key is used for navigating.
The value of this option will be passed to the tabindex
attribute of the HTML element that underlies the widget.
text
The read-only option that holds the text displayed by the widget input element.
type
A format used to display date/time information.
You can assign the following values to this option:
- date - the widget displays only the date;
- time - the widget displays only the time;
- datetime - the widget displays both the date and time.
When using the widget as an ASP.NET MVC Control, specify this option using the DateBoxType
enum. This enum accepts the following values: Date
, DateTime
and Time
.
useCalendar
Use the pickerType property instead.
Specifies whether or not a user can pick out a date using the drop-down calendar.
useNative
Use the pickerType property instead.
Specifies whether or not the widget uses the native HTML input element.
validationError
Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.
See Also
validationMessageMode
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
The following option values are possible:
- auto
The tooltip with the message is displayed when the editor is in focus. - always
The tooltip with the message is not hidden when the editor loses focus.
When using the widget as an ASP.NET MVC Control, specify this option using the ValidationMessageMode
enum. This enum accepts the following values: Auto
and Always
.
value
An object or a value specifying the date and time currently selected using the date box.
You can specify the current widget value using any of the following formats.
Date
Specifies the date directly.Number
Specifies the date using a timestamp (total milliseconds since 1970/01/01).String
Specifies the date using a string value. The widget supports the following formats of a date string.- 'yyyy-MM-dd' (for example, '2017-03-06')
- 'yyyy-MM-ddTHH:mm:ss' (for example, '2017-03-27T16:54:48')
- 'yyyy-MM-ddTHH:mm:ssZ' (for example, '2017-03-27T13:55:41Z')
- 'yyyy-MM-ddTHH:mm:ssx' (for example, '20170327T16:54:10+03')
If the widget value is changed by an end-user, the new value is saved in the same format as the initial value.
See Also
valueChangeEvent
Specifies the DOM events after which the widget's value should be updated.
This option accepts a single event name or several names separated by spaces.
The recommended events are "keyup", "blur", "change", and "focusout", but you can use other events as well.
width
Specifies the widget's width.
This option accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
If you have technical questions, please create a support ticket in the DevExpress Support Center.