Blazor JqxCalendar API Reference

Name	Type
Properties
backText	string
Sets or gets the tooltip text displayed when the mouse cursor is over the back navigation button.
columnHeaderHeight	double
Sets or gets the Calendar colomn header's height. In the column header are displayed the calendar day names.
clearString	string
Sets or gets the 'Clear' string displayed when the 'showFooter' property is true.
culture	string
Sets or gets the jqxCalendar's culture. The culture settings are contained within a file with the language code appended to the name, e.g. jquery.glob.de-DE.js for German. To set the culture, you need to include the jquery.glob.de-DE.js and set the culture property to the culture's name, e.g. 'de-DE'.
dayNameFormat	object
Sets or gets the name format of days of the week. Possible Values: `'default'` `'shortest'` `'firstTwoLetters'` `'firstLetter'` `'full'`
disabled	bool
Disables (true) or enables (false) the calendar. Can be set when initialising (first creating) the calendar.
enableWeekend	bool
Sets or gets a value indicating whether weekend persists its view state.
enableViews	bool
Determines whether switching between month, year and decade views is enabled.
enableOtherMonthDays	bool
Sets or gets a value indicating whether the other month days are enabled.
enableFastNavigation	bool
Sets or gets a value indicating whether the fast navigation is enabled.
enableHover	bool
Sets or gets a value indicating whether the hover state is enabled. The hover state is activated when the mouse cursor is over a calendar cell. The hover state is automatically disabled when the calendar is displayed in touch devices.
enableAutoNavigation	bool
Sets or gets a value indicating whether the auto navigation is enabled. When this property is true, click on other month date will automatically navigate to the previous or next month.
enableTooltips	bool
Sets or gets a value indicating whether the tool tips are enabled.
forwardText	string
Sets or gets the tooltip text displayed when the mouse cursor is over the forward navigation button. EnableTooltips property should be set to true.
firstDayOfWeek	double
Sets or gets which day to display in the first day column. By default the calendar displays 'Sunday' as first day.
height	object
Sets or gets the height of the Calendar.
min	object
Represents the minimum navigation date.
max	object
Represents the maximum navigation date.
navigationDelay	double
Determines the animation delay between switching views.
rowHeaderWidth	object
Sets or gets the row header width.
readOnly	bool
Sets or gets the calendar in read only state.
restrictedDates	DateTime[]
Sets or gets the calendar's restricted dates. These are dates which cannot be clicked.
rtl	bool
Sets or gets a value indicating whether widget's elements are aligned to support locales using right-to-left fonts.
stepMonths	double
Represents the calendar`s navigation step when the left or right navigation button is clicked.
showWeekNumbers	bool
Sets or gets a value whether the week`s numbers are displayed.
showDayNames	bool
Sets or gets a value whether the day names are displayed. By default, the day names are displayed.
showOtherMonthDays	bool
Sets or gets a value whether the other month days are displayed.
showFooter	bool
Sets or gets a value indicating whether the calendar's footer is displayed.
selectionMode	object
Sets or gets the selection mode. Possible Values: `'none'` `'default'` `'range'`
specialDates	object[]
Sets or gets a special date to the Calendar.
theme	string
Sets the widget's theme. Include the theme's CSS file after jqx.base.css. The following code example adds the 'material' theme. `<link rel="stylesheet" href="../../jqwidgets/styles/jqx.base.css" type="text/css" /> <link rel="stylesheet" href="../../jqwidgets/styles/jqx.material.css" type="text/css" />` Set the widget's theme property to 'material' when you initialize it.
titleHeight	double
Sets or gets the title height where the navigation arrows are displayed.
titleFormat	object
Sets or gets the title format for the title section. Possible Values: `'d' - the day of the month` `'dd' - the day of the month` `'ddd' - the abbreviated name of the day of the week` `'dddd' - the full name of the day of the week` `'h' - the hour, using a 12-hour clock from 1 to 12` `'hh' - the hour, using a 12-hour clock from 01 to 12` `'H' - the hour, using a 24-hour clock from 0 to 23` `'HH' - the hour, using a 24-hour clock from 00 to 23` `'m'-the minute, from 0 through 59` `'mm' - the minutes,from 00 though59` `'M' - the month, from 1 through 12;` `'MM' - the month, from 01 through 12` `'MMM' - the abbreviated name of the month` `'MMMM' - the full name of the month` `'s' - the second, from 0 through 59` `'ss' - the second, from 00 through 59` `'t' - the first character of the AM/PM designator` `'tt' - the AM/PM designator` `'y' - the year, from 0 to 99` `'yy' - the year, from 00 to 99` `'yyy' - the year, with a minimum of three digits` `'yyyy' - the year as a four-digit number`
todayString	string
Sets or gets the 'Today' string displayed when the 'showFooter' property is true.
value	DateTime
Sets or gets the Calendar's value.
width	object
Sets or gets the width of the Calendar.
Events
onBackButtonClick	Event
This event is triggered when the calendar back navigation button is clicked.
onChange	Event
This event is triggered when the Calendar's selection is changed.
onNextButtonClick	Event
This event is triggered when the calendar next navigation button is clicked.
onViewChange	Event
This event is triggered when the Calendar's view is changed.
Methods
Name	Arguments	Return Type
clear	()	void
Clears the selection.
destroy	()	void
Destroys the widget.
focus	()	void
Focuses the Calendar.
addSpecialDate	(object date, object specialDateClass, object text)	void

getMinDate	()	object
When the getMinDate method is called, the user gets the lowest navigation date set to the Calendar.
getMaxDate	()	object
When the getMaxDate method is called, the user gets the hightest navigation date set to the Calendar. The retuned value is a JavaScript Date object.
getDate	()	object
When the getDate method is called, the user gets the current month displayed in the Calendar.The returned value is a JavaScript Date object.
getRange	()	object
Gets the selection range when the selectionMode is set to 'range'. The returned value is an object with "from" and "to" fields. Each of these is a JavaScript Date object.
navigateForward	(double months)	void
When the navigateForward method is called, the calendar navigates forward with a specific month step (by default 1).
navigateBackward	(double months)	void
When the navigateBackward method is called, the calendar navigates backward with a specific month step (by default 1).
render	()	void
Renders the Calendar.
refresh	()	void
Performs a layout and updates the UI.
setMinDate	(object date)	void
When the setMinDate method is called, the user sets the lowest date to which it is possible to navigate.
setMaxDate	(object date)	void
When the setMaxDate method is called, the user sets the hightest date to which it is possible to navigate.
setDate	(object date)	void
When the setDate method is called, the user sets the current month displayed in the Calendar. The parameter is a JavaScript Date object.
setRange	(object date, object date2)	void
Sets the selection range when the selectionMode is set to 'range'. The parameters are JavaScript Date objects.
today	()	void
Sets the Date to Today.
val	[SET] (object value, object value2) [GET] ()	[SET] void [GET] object
Gets or sets the jqxCalendar's value.

Properties

Events

Methods