SpreadsheetIndex Property

The index of the current spreadsheet in a Google Spreadsheet feed.

Syntax

 gspreadsheets.getSpreadsheetIndex([callback])
 gspreadsheets.setSpreadsheetIndex( spreadsheetIndex, [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 getSpreadsheetIndex([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 setSpreadsheetIndex([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 spreadsheet within a retrieved Google Spreadsheet feed. Once set, the following properties will be populated:

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

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

This property is not available at design time.

Data Type

Integer