Configuration

An object defining configuration options for the Calendar widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

Type: String
Default Value: null

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.

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" - a local date

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

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

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

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

disabled

Specifies whether the widget responds to user interaction.

Type: Boolean
Default Value: false

elementAttr

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

Type: Object
Default Value: {}

You can configure this option in an ASP.NET MVC Control as follows:

Razor C#
Razor VB
@(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" }
    })
)

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 using the widget as an ASP.NET MVC Control, 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 the widget can be focused using keyboard navigation.

Type: Boolean
Default Value: false
Default for generic: true

height

Specifies the widget's height.

Type: Number|String| function
Return Value: Number|String

The widget height.

Default Value: undefined

This option accepts a value of one of the following types.

  • Number
    The height of the widget 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:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }
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 text for a hint that appears when a user pauses on the widget.

Type: String
Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type: Boolean
Default Value: true

isValid

Specifies whether the editor's value is valid.

Type: Boolean
Default Value: true

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.

JavaScript
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 latest date the widget allows to select.

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 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.

See Also

min

The earliest date the widget allows to select.

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 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.

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 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.

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.

Type: function
Function parameters:

Information about the event.

Object structure:
component: Object
element: jQuery

The widget's container.

model: Object

The model data. Available only if you use Knockout.

Default Value: null

onInitialized

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

Type: function
Function parameters:

Information about the event.

Object structure:
component: Object
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. Executed after an option of the widget is changed.

Type: function
Function parameters:

Information about the event.

Object structure:
component: Object
name: String

A short name of the option whose value has been changed.

fullName: String

A full name of the option whose value has been changed; contains a full hierarchy of the option.

value: any

A new value for the option.

element: jQuery

The widget's container.

model: Object

The model data. Available only if you use Knockout.

Default Value: null

onValueChanged

A handler for the valueChanged event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's 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

Switches the widget to a right-to-left representation.

Type: Boolean
Default Value: false

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.

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

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 number of the element when the Tab key is used for navigating.

Type: Number
Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

validationError

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

Type: Object
Default Value: undefined

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.

JavaScript
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

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 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 in the calendar.

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

Specifies whether the widget is visible.

Type: Boolean
Default Value: true

width

Specifies the widget's width.

Type: Number|String| function
Return Value: Number|String

The widget width.

Default Value: undefined

This option accepts a value of one of the following types.

  • Number
    The width of the widget 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:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }
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 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.

View Demo

Show Example:
AngularJS
Knockout
jQuery