EventIndex Property

The index of the current event in a Google Calendar Event feed.

Syntax

 gcalendar.getEventIndex([callback])
 gcalendar.setEventIndex( eventIndex, [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 getEventIndex([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 setEventIndex([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 an event within a retrieved Google Calendar Event feed.

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

Setting EventIndex to -1 will clear the entries contained by the component and will also reset all the event related properties.

This property is not available at design time.

Data Type

Integer