XmlFilterObject.AddField Method (String)

XmlFilterObjectAddField Method (String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Adds a new field to the collection of field to filter. The field does not return data.

Namespace: ContentStudio.Document.EPT
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

public void AddField(
	string fieldName
)

Public Sub AddField ( 
	fieldName As String
)

fieldName: Type: SystemString
The name of the field to filter on. The field name must be unique and cannot be null or Empty, nor can its length exceed MAX_FIELD_NAME_SIZE characters.

Exceptions

Exception	Condition
CSInvalidParameterException	There are too many fields in the collection.
ArgumentNullException	The FieldName cannot be null
ArgumentException	The field name already exists in the collection

Remarks

If this field is used for sorting the data type is the default String data type.