UpdateWorksheet Method

Updates a Google Worksheet.

Syntax

gspreadsheets.updateWorksheet([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 class will update the Google Worksheet specified by WorksheetIndex. It will update the worksheet with the values contained within the following properties:

Note that updating WorksheetRowCount and WorksheetColumnCount to values that are less than their original values will delete the cells (and their contents) that do not exist within the new boundaries without warning.

To update the actual content of the worksheet, please refer to UpdateRow and UpdateCell.

When called an "If-Match" header will be sent with the value contained within WorksheetETag.

Upon a successful update, the response will be parsed and the below listed properties will be populated. Thus all previous calendars contained by the component, prior to the UpdateWorksheet 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.