CalendarIndex Property

The index of the current calendar.

Syntax

 gcalendar.getCalendarIndex([callback])
 gcalendar.setCalendarIndex( calendarIndex, [callback])

Default Value

-1

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getCalendarIndex([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setCalendarIndex([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property is used to specify a calendar within the set of calendar. After calling GetCalendar or ListCalendars this may be set to select the calendar. Once set, the following properties will be populated:

• CalendarId
• CalendarETag
• CalendarSummary
• CalendarDescription
• CalendarLocation
• CalendarTimezone

This property takes index values from 0 to CalendarCount-1.

Setting CalendarIndex to -1 will clear the entries contained by the component and will also reset all the calendar related properties (listed above).

This property is not available at design time.

Data Type

Integer