CellPropertiesValueFormat Property

The format of the value for the Google Data entry element.

Syntax

 gspreadsheets.getCellPropertiesValueFormat(index, [callback])
 gspreadsheets.setCellPropertiesValueFormat(index,  cellPropertiesValueFormat, [callback])

Possible Values

  1 (vfText), 
  2 (vfFullXML)

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 getCellPropertiesValueFormat([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 setCellPropertiesValueFormat([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 format of the value for the Google Data entry element.

Used to identify the format of the Value property. If the entry element contains sub-elements (children), this property will be set to vfFullXML. Otherwise, it will be set to vfText.

This property is also used to specify the how the Value will be sent in an Update request. If set to vfFullXML (default), Value will be sent as specified. If set to vfText, any '<', '>', and '&' characters within Value are escaped to '<', '>', and '&'.

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

This property is not available at design time.

Data Type

Integer