RadCalendar for ASP.NET AJAX
Contents
RadControls for ASP.NET AJAX

The following table lists the most important properties and methods of the RadCalendar client-side object.

Note

The RadCalendar client object represents dates as 3-element arrays, where the elements represent the year, month, and day, in that order.

Properties

Name

Parameters

Return Type

Description

get_selectedDates

none

Array of triplets

Returns an array of triplets that represent the selected dates in the calendar.

get_focusedDate

none

Array (triplet)

Returns the triplet that represents the currently focused date. The focused Date is the date that determines which view the calendar displays.

get_rangeMinDate

none

Array (triplet)

Returns the triplet that represents the minimum date that can be selected.

set_rangeMinDate

Array (triplet)

none

Sets the minimum date that can be selected to the date that the array parameter represents.

get_monthYearNavigationSettings

none

Array

Returns an array with the fast navigation settings. The settings are, in order, TodayButtonCaption, OkButtonCaption, CancelButtonCaption, DateIsOutOfRangeMessage, EnableTodayButtonSelection.

Caution

Changes you make to these settings have an effect only if you make them before the first time the month/year navigation popup is displayed.

get_calendarEnableMonthYearFastNavigation

none

boolean

Returns whether the month/year navigation popup is enabled.

set_calendarEnableMonthYearFastNavigation

boolean

none

Sets whether the month/year navigation popup is enabled.

get_calendarEnableNavigation

none

boolean

Returns whether the navigation buttons appear on the title bar.

Note

Setting this property on the client has no effect.

get_orientation

none

integer

Returns 1 if the orientation is "RenderInRows", 2 if it is "RenderInColumns".

get_fastNavigationStep

none

integer

Returns the number of months by which the view changes when the user clicks the fast navigation buttons.

set_fastNavigationStep

integer

none

Sets the number of months by which the view changes when the user clicks the fast navigation buttons.

get_multiViewRows

none

integer

Returns the number of rows when the calendar is in multi-view mode (the number of months in each column).

get_multiViewColumns

none

integer

Returns the number of columns when the calendar is in multi-view mode (the number of months in each row).

get_singleViewRows

none

integer

Returns the number of rows in each month view.

get_singleViewColumns

none

integer

Returns the number of columns in each month view.

get_enableMultiSelect

none

boolean

Returns true if the calendar allows multiple dates to be selected.

set_enableMultiSelect

boolean

none

Sets whether the calendar allows multiple dates to be selected.

get_showOtherMonthsDays

none

boolean

Returns true if the calendar displays days from months other than the focused month.

set_showOtherMonthsDays

boolean

none

Sets whether the calendar displays days from months other than the focused month.

get_specialDaysArray

none

Array

Returns an array (0-offset)containing information about the special days that are defined. Each element in the array is an array (1-offset) with the following elements (in order): a triplet for the date, four elements that are not used client-side, an indicator of the repeatable status of the special day, another unused element, the tool tip for the day, and array with the style settings for the special day.

get_element

none

HTML element

Gets the DOM element for the calendar.

get_culture

none

string

Returns the RadCalendar culture name.

get_rangeSelectionStartDate

none

Date

Returns a triplet that represent the start date of the selected range

get_rangeSelectionEndDate

none

Date

Returns a triplet that represent the end date of the selected range

set_datesInRange(startDate, endDate)

Date, Date

none

Set selection date range

DateTimeFormatInfo

DateTimeFormatInfo

The helper object that the calendar uses for formatting date and time information. You can use this object as well for formatting dates in client-side code.

Copyget_selectedDates()
 <script type="text/javascript">
     var calendar = $find("<%= RadCalendar1.ClientID %>");
     var dates = calendar.get_selectedDates();
     for (var i = 0; i < dates.length; i++) {
         var date = dates[i];
         var year = date[0];
         var month = date[1];
         var day = date[2];
         if (year < 2000)
             calendar.unselectDate(date);
     }        
</script>

Methods

Name

Parameters

Return Type

Description

selectDate

Array (triplet), boolean

none

Selects the date represented by the triplet that is the first parameter. If the second parameter is true, the calendar navigates to the view containing the newly selected date (see sample below).

selectDates

Array, boolean

none

Selects the set of dates in the first parameter, where each date is represented by triplet. If the second parameter is true, the calendar navigates to the view containing the newly selected dates (see sample below).

unselectDate

Array (triplet)

none

Unselects the date represented by the parameter if it is currently selected (see sample below).

unselectDates

Array of triplets

none

Un-selects all the dates represented by triplets in the array if they are currently selected (see sample below).

navigateToDate

Array (triplet)

none

Causes the calendar to switch to the view containing the specified date (see sample below).

calculateDateFromStep

integer

Array (triplet)

Returns the triplet for the date that is offset by the specified number of days from the current month. If the parameter is positive, the days are offset from the last day of the month. If the parameter is negative, the days are offset from the first day of the month (see sample below).

CopyselectDate()
<script type="text/javascript">
    function SelectToday() {
        var todaysDate = new Date();
        var todayTriplet = [todaysDate.getFullYear(), todaysDate.getMonth() + 1, todaysDate.getDate()];
        var calendar = $find("<%=RadCalendar1.ClientID%>");
        calendar.selectDate(todayTriplet, true);
    }
   </script>
CopyselectDates()
     <script type="text/javascript">
         function SelectTodayAndTomorrow() {
             var todaysDate = new Date();
             var todayTriplet = [todaysDate.getFullYear(), todaysDate.getMonth() + 1, todaysDate.getDate()];
             var tomorrowTriplet = [todaysDate.getFullYear(), todaysDate.getMonth() + 1, todaysDate.getDate() + 1];
             var selectedDates = [todayTriplet, tomorrowTriplet];
             var calendar = $find("<%=RadCalendar1.ClientID%>");
             calendar.selectDates(selectedDates, true);
         }        
</script>
CopyunselectDate()
     
     <script type="text/javascript">
         function UnselectToday() {
             var todaysDate = new Date();
             var todayTriplet = [todaysDate.getFullYear(), todaysDate.getMonth() + 1, todaysDate.getDate()];
             var calendar = $find("<%=RadCalendar1.ClientID%>");
             calendar.unselectDate(todayTriplet);
         }        
</script>
CopyunselectDates()
     <script type="text/javascript">
         function ClearCalendar() {
             var calendar = $find("<%= RadCalendar1.ClientID %>");
             calendar.unselectDates(calendar.get_selectedDates());
         }
</script>
CopynavigateToDate()
     
     <script type="text/javascript">
         function GoToSummerOfLove() {
             var triplet = [1968, 6, 1];
             var calendar = $find("<%=RadCalendar1.ClientID%>");
             calendar.set_rangeMinDate([1960, 1, 1]);
             calendar.navigateToDate(triplet);
         }
</script>
CopycalculateDateFromStep()
     
     <script type="text/javascript">
         function GoForwardSixMonths() {
             var calendar = $find("<%=RadCalendar1.ClientID%>");
             var target = calendar.calculateDateFromStep(183);
             calendar.navigateToDate(target);
         }
</script>

See Also

Other Resources

Client-Side Basics