Calendar API overview
Methods
| Name | Description |
|---|---|
| clear() | clears the value set in the calendar |
| destructor() | removes a calendar instance and releases occupied resources |
| getCurrentMode() | returns the current mode of displaying Calendar |
| getValue() | returns the selected date |
| link() | links a calendar to another calendar for selecting a date range |
| paint() | repaints a calendar on a page |
| setValue() | selects a date in the calendar |
| showDate() | shows a specified date and/or opens the calendar in one of the available modes |
Events
| Name | Description |
|---|---|
| beforeChange | fires before the change of date selection |
| cancelClick | fires when the user clicks on the "Cancel" control |
| change | fires on change of date selection |
| dateMouseOver | fires when the mouse pointer is over a date |
| modeChange | fires on change of the calendar mode |
| monthSelected | fires after a month was selected in the calendar |
| yearSelected | fires after a year was selected in the calendar |
Properties
| Name | Description |
|---|---|
| css | Optional. Adds style classes to Calendar |
| date | Optional. Defines the date that will be opened when the calendar is created |
| dateFormat | Optional. Defines the format of dates in Calendar |
| disabledDates | Optional. Allows disabling some date intervals, day labels are dimmed |
| mark | Optional. Adds a CSS class to specific days |
| mode | Optional. The mode of Calendar initialization |
| range | Optional. Enables/disables the possibility to select a range of dates on the calendar |
| thisMonthOnly | Optional. Hides dates of the previous/next months relative to the currently displayed one |
| timeFormat | Optional. Defines the time format for a timepicker in the calendar |
| timePicker | Optional. Adds a timepicker into the calendar |
| value | Optional. Selects the day (adds a round blue marker) |
| weekNumbers | Optional. Defines whether to show the numbers of weeks |
| weekStart | Optional. Sets the starting day of the week |
| width | Optional. Sets the width of the calendar |