Angular DateBox Properties
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
adaptivityEnabled
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 UI component to have a more compact representation. For this purpose, assign true to the adaptivityEnabled property. In the adaptive mode, the date box is displayed without the digital clock face.
applyValueMode
The property 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. When the pickerType is 'calendar', choosing this mode activates the showTodayButton property."instantly"
Applies the selected value immediately after a user clicks the required value in the drop-down menu. This mode cannot be used if the pickerType is "rollers" or the type is "datetime".
Use the EditorApplyValueMode
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Instantly
and UseButtons
.
buttons[]
Built-in buttons should also be declared in this array. You can find an example in the following demo:
calendarOptions
Configures the calendar's value picker. Applies only if the pickerType is "calendar".
You can specify most of the Calendar properties in this object except those listed below. These properties are overridden by their DateBox counterparts.
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 UI component cannot detect its format. In this case, specify the dateSerializationFormat property 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 property 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 that users cannot select. Applies only if pickerType is "calendar".
This property accepts an array of dates:
jQuery
$(function() { $("#dateBoxContainer").dxDateBox({ // ... disabledDates: [ new Date("07/1/2017"), new Date("07/2/2017"), new Date("07/3/2017") ] }); });
Angular
<dx-date-box ... [disabledDates]="disabledDates"> </dx-date-box>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { disabledDates: Date[] = [ new Date("07/1/2017"), new Date("07/2/2017"), new Date("07/3/2017") ]; }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxDateBoxModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxDateBoxModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxDateBox ... :disabled-dates="disabledDates" /> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxDateBox from 'devextreme-vue/date-box'; export default { components: { DxDateBox }, data() { return { disabledDates: [ new Date("07/1/2017"), new Date("07/2/2017"), new Date("07/3/2017") ] } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DateBox from 'devextreme-react/date-box'; class App extends React.Component { constructor() { this.disabledDates = [ new Date("07/1/2017"), new Date("07/2/2017"), new Date("07/3/2017") ]; } render() { return ( <DateBox ... disabledDates={this.disabledDates} /> ); } } export default App;
Alternatively, pass a function to disabledDates. This function should define the rules that determine whether the checked date is disabled. A separate set of rules should target every view individually.
jQuery
$(function() { $("#dateBoxContainer").dxDateBox({ // ... disabledDates: function(args) { const dayOfWeek = args.date.getDay(); const month = args.date.getMonth(); const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 ); const isMarch = (args.view === "year" || args.view === "month") && month === 2; return isWeekend || isMarch; } }); });
Angular
<dx-date-box ... [disabledDates]="disableDates"> </dx-date-box>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { disableDates(args) { const dayOfWeek = args.date.getDay(); const month = args.date.getMonth(); const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 ); const isMarch = (args.view === "year" || args.view === "month") && month === 2; return isWeekend || isMarch; } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxDateBoxModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxDateBoxModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxDateBox ... :disabled-dates="disableDates" /> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxDateBox from 'devextreme-vue/date-box'; export default { components: { DxDateBox }, methods: { disableDates(args) { const dayOfWeek = args.date.getDay(); const month = args.date.getMonth(); const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 ); const isMarch = (args.view === "year" || args.view === "month") && month === 2; return isWeekend || isMarch; } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DateBox from 'devextreme-react/date-box'; class App extends React.Component { disableDates(args) { const dayOfWeek = args.date.getDay(); const month = args.date.getMonth(); const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 ); const isMarch = (args.view === "year" || args.view === "month") && month === 2; return isWeekend || isMarch; } render() { return ( <DateBox ... disabledDates={this.disableDates} /> ); } } export default App;
displayFormat
Specifies the date display format. Ignored if the pickerType property is "native"
Set useMaskBehavior to true to control user input according to the display format.
The default display format is selected automatically based on the current locale.
See Also
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.
dropDownOptions
Configures the drop-down field which holds the content.
See Popup Configuration for properties that you can specify in this object.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#dateBoxContainer").dxDateBox({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-date-box ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-date-box>
import { DxDateBoxModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxDateBoxModule ], // ... })
Vue
<template> <DxDateBox ... :element-attr="dateBoxAttributes"> </DxDateBox> </template> <script> import DxDateBox from 'devextreme-vue/date-box'; export default { components: { DxDateBox }, data() { return { dateBoxAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import DateBox from 'devextreme-react/date-box'; class App extends React.Component { dateBoxAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <DateBox ... elementAttr={this.dateBoxAttributes}> </DateBox> ); } } export default App;
height
This property 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%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
inputAttr
jQuery
$(function(){ $("#dateBoxContainer").dxDateBox({ // ... inputAttr: { id: "inputId" } }); });
Angular
<dx-date-box ... [inputAttr]="{ id: 'inputId' }"> </dx-date-box>
import { DxDateBoxModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxDateBoxModule ], // ... })
ASP.NET MVC Controls
@(Html.DevExtreme().DateBox() .InputAttr("id", "inputId") // ===== or ===== .InputAttr(new { @id = "inputId" }) // ===== or ===== .InputAttr(new Dictionary<string, object>() { { "id", "inputId" } }) )
@(Html.DevExtreme().DateBox() _ .InputAttr("id", "inputId") ' ===== or ===== .InputAttr(New With { .id = "inputId" }) ' ===== or ===== .InputAttr(New Dictionary(Of String, Object) From { { "id", "inputId" } }) )
interval
isValid
See Also
max
See Also
maxZoomLevel
Use the calendarOptions property instead.
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 property makes sense only if the pickerType property is set to "calendar".
Use the CalendarZoomLevel
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Month
, Year
, Decade
, and Century
.
min
See Also
minZoomLevel
Use the calendarOptions property instead.
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 property makes sense only if the pickerType property is set to "calendar".
Use the CalendarZoomLevel
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Month
, Year
, Decade
, and Century
.
name
Specify this property if the UI component lies within an HTML form that will be submitted.
If you configure the UI component as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, use this property to bind the UI component to a model property. If this model property contains Data Annotation validation attributes, you get the client-side validation enabled by default.
onChange
A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
onClosed
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onContentReady
A function that is executed when the UI component's content is ready and each time the content is changed.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only when using Knockout. |
onCopy
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
onCut
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
onEnterKey
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
onFocusIn
Name | Type | Description |
---|---|---|
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 function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
model |
Model data. Available only if Knockout is used. |
onFocusOut
Name | Type | Description |
---|---|---|
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 function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
model |
Model data. Available only if Knockout is used. |
onInitialized
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onInput
A function that is executed each time the UI component's input is changed while the UI component is focused.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
onKeyDown
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
onKeyPress
keyPress
event is removed from the web standards and will be deprecated in modern browsers soon. Refer to the MDN topic for details.Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
onKeyUp
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
onOpened
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onOptionChanged
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
value | any |
The modified property's new value. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#dateBoxContainer").dxDateBox({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-date-box ... (onOptionChanged)="handlePropertyChange($event)"> </dx-date-box>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxDateBoxModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxDateBoxModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxDateBox ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxDateBox from 'devextreme-vue/date-box'; export default { components: { DxDateBox }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DateBox from 'devextreme-react/date-box'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <DateBox ... onOptionChanged={handlePropertyChange} /> ); }
onPaste
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
onValueChanged
A function that is executed after the UI component's value is changed.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
Model data. Available only if Knockout is used. |
|
previousValue |
The UI component's previous value. |
|
value |
The UI component's new value. |
pickerType
This property accepts the following values.
"native"
The picker type depends on the current platform or web browser."calendar"
The date box uses the Calendar UI component to pick data. This value applies only when the type property is set to "date" or "datetime"."rollers"
The UI component uses rollers to pick the date and time."list"
The UI component uses the list of time values to pick the time. This value applies only when the type property is set to "time".
Use the DateBoxPickerType
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Native
, Calendar
, Rollers
, and List
.
placeholder
This text is also shown in the date picker's title in the following cases:
- If the pickerType is "rollers".
- If the application runs on an iOS device and the pickerType is not "native".
readOnly
When this property is set to true, the following applies:
- The editor's value cannot be changed using the UI.
- Built-in action buttons are invisible.
Custom action buttons are visible but disabled. If a button should not be disabled, set its disabled property to false:
jQuery
index.js$(function() { $("#dateBoxContainer").dxDateBox({ // ... buttons: [{ name: "myCustomButton", location: "after", options: { onClick: function(e) { // ... }, disabled: false } }] }); });
Angular
app.component.htmlapp.component.tsapp.module.ts<dx-date-box ... > <dxi-button name="myCustomButton" location="after" [options]="myCustomButtonConfig"> </dxi-button> </dx-date-box>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { myCustomButtonConfig = { onClick: (e) => { // ... }, disabled: false }; }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxDateBoxModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxDateBoxModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
App.vue<template> <DxDateBox ... > <DxDateBoxButton name="myCustomButton" location="after" :options="myCustomButtonConfig" /> </DxDateBox> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxDateBox, { DxButton as DxDateBoxButton } from 'devextreme-vue/date-box'; export default { components: { DxDateBox, DxDateBoxButton }, data() { return { myCustomButtonConfig: { onClick: (e) => { // ... }, disabled: false } } } } </script>
React
App.jsimport React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DateBox, { Button as DateBoxButton } from 'devextreme-react/date-box'; class App extends React.Component { myCustomButtonConfig = { onClick: (e) => { // ... }, disabled: false }; render() { return ( <DateBox> <DateBoxButton name="myCustomButton" location="after" options={this.myCustomButtonConfig} /> </DateBox> ); } } export default App;
You can also hide a custom action button when the UI component becomes read-only. Set the button's visible property to false in the onOptionChanged function. To get the button, use the getButton(name) method:
jQuery
index.js$(function() { $("#dateBoxContainer").dxDateBox({ // ... buttons: [{ name: "myCustomButton", // ... }], onOptionChanged: function(e) { if(e.name == "readOnly") { const myButton = e.component.getButton("myCustomButton"); myButton.option("visible", !e.value); // Hide the button when readOnly: true } } }); });
Angular
app.component.htmlapp.component.tsapp.module.ts<dx-date-box ... (onOptionChanged)="changeButtonState"> <dxi-button name="myCustomButton" ... ></dxi-button> </dx-date-box>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { changeButtonState(e) { if(e.name == 'readOnly') { let myButton = e.component.getButton('myCustomButton'); myButton.option('visible', !e.value); // Hide the button when readOnly: true } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxDateBoxModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxDateBoxModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
App.vue<template> <DxDateBox ... @option-changed="changeButtonState"> <DxDateBoxButton name="myCustomButton" ... /> </DxDateBox> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxDateBox, { DxButton as DxDateBoxButton } from 'devextreme-vue/date-box'; export default { components: { DxDateBox, DxDateBoxButton }, data() { return { // ... } }, methods: { changeButtonState(e) { if(e.name == 'readOnly') { let myButton = e.component.getButton('myCustomButton'); myButton.option('visible', !e.value); // Hide the button when readOnly: true } } } } </script>
React
App.jsimport React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DateBox, { Button as DateBoxButton } from 'devextreme-react/date-box'; class App extends React.Component { changeButtonState(e) { if(e.name == 'readOnly') { let myButton = e.component.getButton('myCustomButton'); myButton.option('visible', !e.value); // Hide the button when readOnly: true } } render() { return ( <DateBox ... onOptionChanged={this.changeButtonState}> <DateBoxButton name="myCustomButton" ... /> </DateBox> ); } } export default App;
rtlEnabled
When this property is set to true, the UI component 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
showAnalogClock
Specifies whether to show the analog clock in the value picker. Applies only if type is "datetime" and pickerType is "calendar".
showClearButton
The Clear button calls the reset method.
stylingMode
The following styles are available:
Use the EditorStylingMode
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Outlined
, Underlined
, and Filled
.
You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.
tabIndex
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
type
You can assign the following values to this property:
- date - the UI component displays only the date;
- time - the UI component displays only the time;
- datetime - the UI component displays both the date and time.
Use the DateBoxType
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Date
, DateTime
, and Time
.
useMaskBehavior
Specifies whether to control user input using a mask created based on the displayFormat.
validationError
Information on the broken validation rule. Contains the first item from the validationErrors array.
validationMessageMode
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
The following property 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.
Use the ValidationMessageMode
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Auto
and Always
.
value
You can specify the current UI component 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 UI component 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 UI component 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 UI component's value should be updated.
This property accepts a single event name or several names separated by spaces.
The recommended events are "keyup", "blur", "change", "input", and "focusout", but you can use other events as well.
See Also
width
This property 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.