XmlFilter Properties 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.

Properties

  Name Description
Public property Aggregation
Indicates if and how the query should be aggregated.
(Inherited from XmlFilterObject.)
Public property CategoryID
Returns the EPT category where the filtering should be done.
(Inherited from XmlFilterObject.)
Public property CheckForReadPermission
Sets or gets a value that specifies whether Content Studio should check for read permission instead of browse permission.
(Inherited from XmlFilterObject.)
Public property connectionID
Gets a value that identifies the web site.
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.
(Inherited from XmlFilterObject.)
Public property FieldNames
Returns an array of fields names defined in the collection.
(Inherited from XmlFilterObject.)
Public property Code example FilterCriteria
Sets or gets the T-SQL argument to filter on.
(Inherited from XmlFilterObject.)
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.
(Inherited from XmlFilterObject.)
Public property Item
Returns a XmlFilteringFieldDefinition with the specified name. In C# this is the indexer.
(Inherited from XmlFilterObject.)
Public property PageCount
Gets a value that indicates the number of pages found after the filtering operation.
(Overrides XmlFilterObjectPageCount.)
Public property PageNumber
Gets or sets a value that indicates which page to return. This value cannot be less than 1.
(Inherited from XmlFilterObject.)
Public property PageSize
Gets or sets the size of each page used. This value cannot be less than 0.
(Inherited from XmlFilterObject.)
Public property PreviewDate
Sets or gets a value that specifies a point in time to filter.
(Inherited from XmlFilterObject.)
Public property Random
Gets or sets a value indicating whether the data returned from this XmlFilter is sorted randomly.
Public property RangeSize
Gets or sets the number of rows to evaluate depending on the range of pages to return.
(Inherited from XmlFilterObject.)
Public property RecordCount
Gets a value that indicates the number of records found after the filtering operation.
(Overrides XmlFilterObjectRecordCount.)
Public property ReturnExtendedFields
Sets or gets a value that specifies whether Content Studio should return datafields with extra information.
(Inherited from XmlFilterObject.)
Public property sessionID
Gets a value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Public property Code example SortCommand
Sets or gets the T-SQL clause that defines the sort instruction for the returned data.
(Inherited from XmlFilterObject.)
Top
See Also

Reference