WorksheetCount Property

The number of worksheets contained within a Google Worksheet feed.

Syntax

 gspreadsheets.getWorksheetCount([callback])

Default Value

0

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 getWorksheetCount([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 setWorksheetCount([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 updated to reflect the total number of worksheets returned within a response (whether you are retrieving a feed/worksheet or making changes to a feed/worksheet).

This property is read-only and not available at design time.

Data Type

Integer