XmlFilter Methods Content Studio 5.7 SDK
Content Studio Web Content Management System

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

The XmlFilter type exposes the following members.

Methods

  Name Description
Public method AddField(String)
Adds a new field to the collection of field to filter. The field does not return data.
(Inherited from XmlFilterObject.)
Public method AddField(String, XmlIndexQueryQueryDataTypes)
Adds a new field to the collection of field to filter on that does not return data and is of a certain data type. The name of the field must be unique and indexed and the number of fields cannot exceed PARAMETER_COUNT.
(Inherited from XmlFilterObject.)
Public method AddField(String, Boolean)
Adds a new field to the collection of field to filter on, with the possibility to specify whether to return data or not.
(Inherited from XmlFilterObject.)
Public method AddField(String, Boolean, XmlIndexQueryQueryDataTypes)
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.
(Inherited from XmlFilterObject.)
Public method Equals (Inherited from Object.)
Public method ExistsField
Determines whether the collection contains the specified field name.
(Inherited from XmlFilterObject.)
Public method Filter
Performs the filter operation against Content Studio and return data as Xml
(Overrides XmlFilterObjectFilter.)
Public method FilterReader
Performs the filter operation against Content Studio and returns an object that enables the caller to retrieve the data in an object oriented way.
Public method FilterScalar
Performs the filter operation against the Content Studio EPT Xml index and returns the identifier of the first document that matches the filter condition.
Public method Code example FilterScalar(String, String)
Performs the filter operation against Content Studio EPT Xml index and returns the first document identifier that matches the filter condition and data from one field of that document.
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method RemoveField
Removes the XmlFilteringFieldDefinition with the specified name from the collection.
(Inherited from XmlFilterObject.)
Public method ToString (Inherited from Object.)
Top
See Also

Reference