Karamasoft UltimateCalendar Client-Side API

UltimateCalendar Client-Side API

API Element

Description

Example

UltimateCalendars[ultimateCalendarId]

UltimateCalendar object collection.

UltimateCalendars['UltimateCalendar1']
UltimateCalendars['<%=UltimateCalendar1.ClientID%>']
UltimateCalendars.UltimateCalendar1
UltimateCalendars.<%=UltimateCalendar1.ClientID%>

Show([datePickerInputId] [,dateFormat] [,offsetX] [,offsetY])

Shows the calendar for given date picker input text element. Date picker input text element is populated with the selected date formatted according to dateFormat provided when a date is selected on the calendar if its MultiDaySelect property is set to False.

datePickerInputId: Optional. String that specifies the ID of the date picker input text element.
dateFormat: Optional. String that specifies the date format. The default is 'MM/dd/yy'.
offsetX: Optional. String that specifies the horizontal distance between date picker input element and the calendar to show. The default is 0.
offsetY: Optional. String that specifies the vertical distance between date picker input element and the calendar to show. The default is 0.

UltimateCalendars['UltimateCalendar1'].Show('UltimateDatePicker1_txt','MM/dd/yy');

Hide()

Hides the calendar.

UltimateCalendars['UltimateCalendar1'].Hide();

GetSelectedDate()

Gets the selected date as a JavaScript Date object. If MultiDaySelect property of the calendar is set to True, returns the first selected date.

var selectedDate = UltimateCalendars['UltimateCalendar1'].GetSelectedDate();

SetSelectedDate(selectedDate)

Sets the selected date of the calendar to given JavaScript Date object.

selectedDate: Required. JavaScript Date object that specifies the selected date.

UltimateCalendars['UltimateCalendar1'].SetSelectedDate(new Date(2000, 0, 1));

GetSelectedDates()

Gets the selected dates as a JavaScript Date object array.

var selectedDateArr = UltimateCalendars['UltimateCalendar1'].GetSelectedDates();

SetSelectedDates(selectedDateArr)

Sets the selected dates of the calendar to given JavaScript Date object array.

selectedDateArr: Required. JavaScript Date object array that specifies the selected dates.

UltimateCalendars['UltimateCalendar1'].SetSelectedDates(new Array(new Date(2000, 0, 1), new Date(2000, 0, 2)));

GetVisibleDate()

Gets the visible date of the calendar as a JavaScript Date object.

var visibleDate = UltimateCalendars['UltimateCalendar1'].GetVisibleDate();

SetVisibleDate(visibleDate)

Sets the visible date of the calendar to given JavaScript Date object.

visibleDate: Required. JavaScript Date object that specifies the visible date.

UltimateCalendars['UltimateCalendar1'].SetVisibleDate(new Date(2000, 0, 1));

GetMinDate()

Gets the minimum date of the calendar as a JavaScript Date object.

var minDate = UltimateCalendars['UltimateCalendar1'].GetMinDate();

SetMinDate(minDate)

Sets the minimum date of the calendar to given JavaScript Date object.

minDate: Required. JavaScript Date object that specifies the minimum date.

UltimateCalendars['UltimateCalendar1'].SetMinDate(new Date(2000, 0, 1));

GetMaxDate()

Gets the maximum date of the calendar as a JavaScript Date object.

var maxDate = UltimateCalendars['UltimateCalendar1'].GetMaxDate();

SetMaxDate(maxDate)

Sets the maximum date of the calendar to given JavaScript Date object.

maxDate: Required. JavaScript Date object that specifies the maximum date.

UltimateCalendars['UltimateCalendar1'].SetMaxDate(new Date(2000, 0, 1));

GetDateFormat()

Gets date format of the calendar.

var dateFormat = UltimateCalendars['UltimateCalendar1'].GetDateFormat();

SetDateFormat(dateFormat)

Sets date format the calendar to given dateFormat.

dateFormat: Required. String that specifies the date format.

UltimateCalendars['UltimateCalendar1'].SetDateFormat('MM/dd/yy');

FormatDate(currentDate)

Formats given JavaScript date object with dateFormat of the calendar.

currentDate: Required. JavaScript Date object that specifies the date to format.

Note that dateFormat of the calendar should be set using SetDateFormat before FormatDate is called if a date format different than the default (MM/dd/yy) needs to be used.

UltimateCalendars['UltimateCalendar1'].FormatDate(new Date(2000, 0, 1));

IsValidDate(dateVal, dateFormat)

Returns whether a string containing a date is valid date based on given dateFormat.

dateVal: Required. String that contains a date.
dateFormat: Optional. String that specifies the date format. The default is 'MM/dd/yy'.

UltimateCalendars['UltimateCalendar1'].IsValidDate('01/01/2000', 'MM/dd/yyyy');

GetDatePickerInputElem()

Gets current or the last date picker input element used to show the calendar.

var datePickerInputElem = UltimateCalendars['UltimateCalendar1'].GetDatePickerInputElem();

[ultimateCalendarId]_OnBeforeShow()

Function template to handle events before the calendar is shown using Show method on the client-side.

function UltimateCalendar1_OnBeforeShow() {/* custom function */}
function <%=UltimateCalendar1.ClientID%>_OnBeforeShow() {/* custom function */}

[ultimateCalendarId]_OnLoad()

Function template to handle events after the calendar is loaded during page load on the client-side.

function UltimateCalendar1_OnLoad() {/* custom function */}
function <%=UltimateCalendar1.ClientID%>_OnLoad() {/* custom function */}

[ultimateCalendarId]_OnSelectionChanged()

Function template to handle events after the date selection occurs on the client-side.

function UltimateCalendar1_OnSelectionChanged() {/* custom function */}
function <%=UltimateCalendar1.ClientID%>_OnSelectionChanged() {/* custom function */}

[ultimateCalendarId]_OnVisibleMonthChanged()

Function template to handle events after the visible month change occurs on the client-side.

function UltimateCalendar1_OnVisibleMonthChanged() {/* custom function */}
function <%=UltimateCalendar1.ClientID%>_OnVisibleMonthChanged() {/* custom function */}

Date Format

dateFormat should be set according to the following format patterns:

d	The day of the month. Single-digit days will not have a leading zero.
dd	The day of the month. Single-digit days will have a leading zero.
ddd	The abbreviated name of the day of the week, as defined in DateTimeFormatInfo.AbbreviatedDayNames.
dddd	The full name of the day of the week, as defined in DateTimeFormatInfo.DayNames.
M	The numeric month. Single-digit months will not have a leading zero.
MM	The numeric month. Single-digit months will have a leading zero.
MMM	The abbreviated name of the month, as defined in DateTimeFormatInfo.AbbreviatedMonthNames.
MMMM	The full name of the month, as defined in DateTimeFormatInfo.MonthNames.
y	The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero.
yy	The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero.
yyyy	The year in four digits, including the century.

JavaScript Date Object Reference

To learn more about JavaScript Date object, please visit the following link:
Date Object (JScript 5.6)