Configuration

An object defining configuration options for the Calendar widget.

accessKey

Specifies a shortcut key that sets focus on the widget element.

Type:

String

Default Value: null

The accessKey option value is passed to the accesskey attribute of the actual HTML element of the widget.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

Type:

Boolean

Default Value: true

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

cellTemplate

The template to be used for rendering calendar cells.

Type:

template

Function parameters:
itemData:

Object

An object holding data associated with the cell to be rendered.

itemIndex:

Number

The index of the cell to be rendered.

itemElement:

jQuery

An HTML element of the cell to be rendered.

Return Value:

String

|

DOM Node

|

jQuery

A template name or a template container.

Default Value: 'cell'

The binding context of the template as well as the itemData parameter of a function passed to this option is an object containing the following fields.

  • text
    A text displayed by the cell.

  • date
    A Date object associated with the cell.

  • view
    The name of the current view.

NOTE
A binding context of an item template is the data source object that corresponds to the currently rendered cell. To access another binding context within an item template, use Knockout/AngularJS binding variables.
See Also

dateSerializationFormat

Specifies the serialization format for a date-time value.

Type:

String

Default Value: undefined

If you do not set the value at design time, its format cannot be detected automatically by the widget. In this case, specify the dateSerializationFormat option. You can also do this to serialize the value to a specific format.

The following formats are supported.

  • "yyyy-MM-dd" - local date

  • "yyyy-MM-ddTHH:mm:ss" - local date and time

  • "yyyy-MM-ddTHH:mm:ssZ" - UTC date and time

  • "yyyy-MM-ddTHH:mm:ssx" - date and time with timezone

Note that this option applies only if the forceIsoDateParsing field of the global configuration object is set to true.

JavaScript
DevExpress.config({
    forceIsoDateParsing: true
});

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type:

Boolean

Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}

When you configure this option using a server-side wrapper, pass a dictionary as shown in the following code.

Razor C#
Razor VB
@(Html.DevExtreme()
    // other widget options
    // ...
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" },
        // ...
    })
)
@(Html.DevExtreme().WidgetName() _
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

firstDayOfWeek

Specifies the first day of a week.

Type:

Number

Default Value: undefined
Accepted Values: 0 | 1 | 2 | 3 | 4 | 5 | 6

The option can take on a value from 0 to 6.

  • 0 - Sunday
  • 1 - Monday
  • 2 - Tuesday
  • 3 - Wednesday
  • 4 - Thursday
  • 5 - Friday
  • 6 - Saturday

By default, the value provided by the culture settings is used.

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the FirstDayOfWeek enum. This enum accepts the following values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

Show Example:
AngularJS
Knockout
jQuery

focusStateEnabled

Specifies whether or not the widget can be focused.

Type:

Boolean

Default Value: false
Default for generic: true

height

Specifies the height of the widget.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget height.

Default Value: undefined

This option can hold a value of the following types.

  • number
    The height of the widget in pixels

  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget height (e.g., height:function(){ return baseHeight - 10 + "%"; })

NOTE
The widget's minimum height depends on the current theme. If the height option value is less than the minimum height, the widget height is set to the minimum value, ignoring the specified value. Below is a list of minimum calendar sizes depending on the current theme.
  • Generic - 280x270
  • Android - 290x260
  • iOS 260x260
  • Windows- 278x278

hint

Specifies the text of the hint displayed for the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

Type:

Boolean

Default Value: true

isValid

Specifies whether the editor's value is valid.

Type:

Boolean

Default Value: true

In Knockout approach, you may need to use an editor to inform end users that an error occurred during the validation of a ViewModel field. In this instance, set the editor's isValid option to the isValid property value of the dxValidator that validated the ViewModel's field. In addition, set the editor's validationError option to the validationError property value of the dxValidator object.

In the code below, the login specified by an end user is validated on the level of the ViewModel. If validation of the login value fails, a validation message is displayed on the Login editor.

HTML
<div data-bind="dxTextBox: {
    value: login,
    isValid: login.dxValidator.isValid,
    validationError: login.dxValidator.validationError,
    placeholder: 'Login'
}"></div>
JavaScript
var viewModel = {
    login: ko.observable("").extend({
        dxValidator: {
            validationRules: [{
                type: 'required',
                message: 'Login is required'
            }]
        }
    }),
    //...
}
NOTE
The editor's isValid option, as well as the validationError option, 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 latest date the widget allows to select.

Type:

Date

|

Number

|

String

Default Value: new Date(3000, 0)

Show Example:
AngularJS
Knockout
jQuery

maxZoomLevel

Specifies the maximum zoom level of the calendar.

Type:

String

Default Value: 'month'
Accepted Values: 'month' | 'year' | 'decade' | 'century'

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the CalendarZoomLevel enum. This enum accepts the following values: Month, Year, Decade and Century.

See Also

min

The earliest date the widget allows to select.

Type:

Date

|

Number

|

String

Default Value: new Date(1000, 0)

Show Example:
AngularJS
Knockout
jQuery

minZoomLevel

Specifies the minimum zoom level of the calendar.

Type:

String

Default Value: 'century'
Accepted Values: 'month' | 'year' | 'decade' | 'century'

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the CalendarZoomLevel enum. This enum accepts the following values: Month, Year, Decade and Century.

See Also

name

The value to be assigned to the name attribute of the underlying HTML element.

Type:

String

Default Value: ''

Specify this option if the widget lies within an HTML form that will be submitted.

If you configure the widget using DevExtreme ASP.NET MVC Wrappers, 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.

onDisposing

A handler for the disposing event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE
The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

jQuery

The widget's container.

Default Value: null

You cannot access elements in the widget because this handler is executed before they are ready. Use the onContentReady handler instead.

onOptionChanged

A handler for the optionChanged event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

name:

String

Specifies the name of the option whose value is changed.

fullName:

String

Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.

value: any

Specifies a new value for the option.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

onValueChanged

A handler for the valueChanged event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

value:

Object

The widget's new value.

previousValue:

Object

The widget's previous value.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

Default Value: null

Assign a function to perform a custom action when the editor value changes.

readOnly

A Boolean value specifying whether or not the widget is read-only.

Type:

Boolean

Default Value: false

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type:

Boolean

Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

showTodayButton

Specifies whether or not the widget displays a button that selects the current date.

Type:

Boolean

Default Value: false

Show Example:
AngularJS
Knockout
jQuery

tabIndex

Specifies the widget tab index.

Type:

Number

Default Value: 0

validationError

Holds the object that defines the error that occurred during validation.

Type:

Object

Default Value: undefined

In Knockout approach, you may need to use an editor to inform end users that an error occurred during the validation of a ViewModel field. In this instance, set the editor's isValid option to the isValid property value of the dxValidator that validated the ViewModel's field. In addition, set the editor's validationError option to the validationError property value of the dxValidator object.

In the code, the login specified by an end user is validated on the level of the ViewModel. If validation of the login value fails, a validation message is displayed on the Login editor.

HTML
<div data-bind="dxTextBox: {
    value: login,
    isValid: login.dxValidator.isValid,
    validationError: login.dxValidator.validationError,
    placeholder: 'Login'
}"></div>
JavaScript
var viewModel = {
    login: ko.observable("").extend({
        dxValidator: {
            validationRules: [{ type: 'required', message: 'Login is required' }]
        }
    }),
    //...
}

The editor's validationError option, as well as the isValid option, 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

validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Type:

String

Default Value: 'auto'
Accepted Values: 'auto' | 'always'

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 configuring the widget using ASP.NET MVC Wrappers, 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 in the calendar.

Type:

Date

|

Number

|

String

Default Value: null

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, '2017-03-27T16: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.

Show Example:
AngularJS
Knockout
jQuery

visible

A Boolean value specifying whether or not the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the width of the widget.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget width.

Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget width in pixels.
  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget width. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }
NOTE
The widget has a minimum width that depends on the current theme. If the width option value is less than the minimum width, the widget width is set to the minimum value, ignoring the specified value. Below is a list of minimum calendar sizes depending on the current theme.
  • Generic - 280x270
  • Android - 290x260
  • iOS 260x260
  • Windows- 278x278

zoomLevel

Specifies the current calendar zoom level.

Type:

String

Default Value: 'month'
Accepted Values: 'month' | 'year' | 'decade' | 'century'

Zoom level determines the size of a date range displayed on a single calendar page.

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the CalendarZoomLevel enum. This enum accepts the following values: Month, Year, Decade and Century.

View Demo

Show Example:
AngularJS
Knockout
jQuery