WorksheetPropertiesName Property

The Name of the Google data entry element.

Syntax

 gspreadsheets.getWorksheetPropertiesName(index, [callback])
 gspreadsheets.setWorksheetPropertiesName(index,  worksheetPropertiesName, [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 getWorksheetPropertiesName([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 setWorksheetPropertiesName([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 Name of the Google data entry element.

Setting this property to empty string prior to calling UpdateEntry will result in the item not being sent in the update request. Thus removing it from the Google Data entry.

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

This property is not available at design time.

Data Type

String