ColumnRawXML Property

The raw XML content for the column description.

Syntax

 spsite.getColumnRawXML(index, [callback])
 spsite.setColumnRawXML(index,  columnRawXML, [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 getColumnRawXML([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 setColumnRawXML([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 raw XML content for the column description.

This value may be used to define custom column types.

Example:

Column col = new Column();
col.RawXML = "<Field Name=\"new column\" Type=\"My Type\" OtherField=\"Other Value\" />";

SiteControl.Columns.Add(col);
SiteControl.AddColumns("MyList");

NOTE: When using this property to send custom xml for the specified column, do not set any other propertys for this column after setting the value for ColumnRawXML. When another property is set, the class will automatically regenerate the xml for this column before sending the information to the server.

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

This property is not available at design time.

Data Type

String