XmlFilterObjectAddField Method (String, Boolean, XmlIndexQueryQueryDataTypes) 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 on, with the possibility to specify whether to return data for the field and specify a data type for sorting.

Namespace: ContentStudio.Document.EPT
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public void AddField(
	string fieldName,
	bool returnData,
	XmlIndexQueryQueryDataTypes dataType
)

Parameters

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.
returnData
Type: SystemBoolean
Indicates whether this field returns data or not.
dataType
Type: ContentStudio.Document.EPTXmlIndexQueryQueryDataTypes
Indicates the data type of the field. This value is only used for fields that are used for sorting.
Exceptions
ExceptionCondition
CSInvalidParameterExceptionThere are too many fields in the collection.
ArgumentOutOfRangeException
  • The FieldName is empty or too long.
  • DataType has an invalid value.
ArgumentNullExceptionThe FieldName cannot be null.
ArgumentExceptionThe field name already exists in the collection.
See Also

Reference

XmlFilterObject Class
AddField Overload
ContentStudio.Document.EPT Namespace