ColumnName Property

The schema name for the column.

Syntax

 spsite.getColumnName(index, [callback])
 spsite.setColumnName(index,  columnName, [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 getColumnName([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 setColumnName([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 schema name for the column. This is used internally in SharePoint Lists.

To set the actual visible name of the column, please refer to ColumnDisplayName.

NOTE: This property is required when adding a column to the site or list.

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

This property is not available at design time.

Data Type

String