Content Studio Web Content Management System
SystemObject
ContentStudio.Document.EPTXmlFilterObject
ContentStudio.Document.EPTXmlFilter
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
Top
[This is preliminary documentation and is subject to change.]
This class acts as base class for classes that performs query operations against the Content Studio xml index.
Inheritance Hierarchy
ContentStudio.Document.EPTXmlFilterObject
ContentStudio.Document.EPTXmlFilter
Namespace: ContentStudio.Document.EPT
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
[SerializableAttribute] public abstract class XmlFilterObject : IEnumerable<KeyValuePair<string, XmlFilteringFieldDefinition>>, IEnumerable
The XmlFilterObject type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | XmlFilterObject |
Creates a new instance of the XmlFiltering class.
|
Properties
| Name | Description | |
|---|---|---|
 | Aggregation |
Indicates if and how the query should be aggregated.
|
| CategoryID | Returns the EPT category where the filtering should be done. |
| CheckForReadPermission |
Sets or gets a value that specifies whether Content Studio should check for read permission instead of browse permission.
|
| DraftsOnly |
Sets or gets a value that specifies whether the draft should be queried and optionally returned instead of the published content. Pass null (Nothing in Visual Basic) to filter against the draft or the approved content, if draft was not found.
|
| FieldNames |
Returns an array of fields names defined in the collection.
|
 | FilterCriteria |
Sets or gets the T-SQL argument to filter on.
|
| IgnorePublishStatus |
Sets or gets a value that specifies whether the published flag should be checked. If this property is turned off performance can be improved. Note that unpublished documents will be included in the result with this property set to true.
|
| Item |
Returns a XmlFilteringFieldDefinition with the specified name. In C# this is the indexer.
|
| PageCount |
When implemented in derived classes gets the number of pages found.
|
| PageNumber | Gets or sets a value that indicates which page to return. This value cannot be less than 1.
|
| PageSize | Gets or sets the size of each page used. This value cannot be less than 0.
|
| PreviewDate |
Sets or gets a value that specifies a point in time to filter.
|
| RangeSize | Gets or sets the number of rows to evaluate depending on the range of pages to return.
|
| RecordCount |
When implemented in derived classes gets the number of data rows found.
|
| ReturnExtendedFields |
Sets or gets a value that specifies whether Content Studio should return datafields with extra information.
|
| SortCommand |
Sets or gets the T-SQL clause that defines the sort instruction for the returned data.
|
Methods
| Name | Description | |
|---|---|---|
 | AddField(String) |
Adds a new field to the collection of field to filter. The field does not return data.
|
| 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.
|
| 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.
|
| 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.
|
| Equals | (Inherited from Object.) |
| ExistsField |
Determines whether the collection contains the specified field name.
|
| Filter |
When implemented in derived classes, performs the actual filtering against Content Studio
|
| Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| RemoveField |
Removes the XmlFilteringFieldDefinition with the specified name from the collection.
|
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | DEFAULT_PAGENUMBER |
Defines the default page number. This field has the value 1.
|
| DEFAULT_PAGESIZE |
Defines the default page size to use. This field has the value 10.
|
See Also