UpdateListColumns Method

Adds, deletes, or updates columns of a list.

Syntax

spsite.updateListColumns(list, [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 Columns collection specifies the columns to be added, deleted, or updated. Set the ColumnUpdateOp property to specify which operation to perform on each column.

When trying to update a system-defined column, the server will return an error. Thus, if ListColumns is called, first clear the Columns before adding the list of user-defined columns to update.

NOTE: When adding a column, the ColumnName property is required.