ElementComponentIndex Property

The index of the selected component of the current element.

Syntax

 edireader.getElementComponentIndex(index, [callback])
 edireader.setElementComponentIndex(index,  elementComponentIndex, [callback])

Default Value

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 getElementComponentIndex([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 setElementComponentIndex([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

The index of the selected component of the current element. ElementComponentIndex valid values are from 0 to (ElementComponentCount - 1).

The size of the array is controlled by the ElementCount property.

This property is not available at design time.

Data Type

Integer