XmlFilterObject Properties Content Studio 5.7 SDK
Content Studio Web Content Management System

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

The XmlFilterObject type exposes the following members.

Properties

  Name Description
Public property Aggregation
Indicates if and how the query should be aggregated.
Public property CategoryID
Returns the EPT category where the filtering should be done.
Public property CheckForReadPermission
Sets or gets a value that specifies whether Content Studio should check for read permission instead of browse permission.
Public property 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.
Public property FieldNames
Returns an array of fields names defined in the collection.
Public property Code example FilterCriteria
Sets or gets the T-SQL argument to filter on.
Public property 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.
Public property Item
Returns a XmlFilteringFieldDefinition with the specified name. In C# this is the indexer.
Public property PageCount
When implemented in derived classes gets the number of pages found.
Public property PageNumber
Gets or sets a value that indicates which page to return. This value cannot be less than 1.
Public property PageSize
Gets or sets the size of each page used. This value cannot be less than 0.
Public property PreviewDate
Sets or gets a value that specifies a point in time to filter.
Public property RangeSize
Gets or sets the number of rows to evaluate depending on the range of pages to return.
Public property RecordCount
When implemented in derived classes gets the number of data rows found.
Public property ReturnExtendedFields
Sets or gets a value that specifies whether Content Studio should return datafields with extra information.
Public property Code example SortCommand
Sets or gets the T-SQL clause that defines the sort instruction for the returned data.
Top
See Also

Reference