CreateWorksheet Method

Creates a new worksheet within the specified Google Spreadsheets feed.

Syntax

gspreadsheets.createWorksheet([callback])

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 this 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 component will create a new worksheet within the spreadsheet specified by SpreadsheetIndex. The items contained within the following properties will be used to create the new worksheet:

If the worksheet was successfully created, the new worksheet will appear as the last worksheet. It is not currently possible to set the order of worksheets via the Google Spreadsheets API (outside of using the GDocuments class to delete and recreate each worksheet).

Upon a successful creation, the response will be parsed and the below listed properties will be populated with the returned values. Thus all previous worksheets contained by the component, prior to the CreateWorksheet call, will be cleared and replaced with the response worksheet data. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.