PropertyFilterType Element

System.Object

PropertyFilterType

 

Client Declaration

Represents information, used in conjunction with one or more FilterElementType elements, for controlling which properties of a Content Engine object (and with what level of detail) will appear in the output of an operation.

When processing a property filter, the server obeys the following rules:

In order for content to be returned via the Content pseudo-property (ContentData element) of a ContentTransfer object, the Content property must be specified for inclusion with a maxRecursion value of at least 1 (one level below the document to which the content belongs) and recursive traversal of the ContentElements property must be enabled. To simplify matters, the server treats an IncludeProperties element specifying the Content property as implicitly including the ContentElements property at the same recursion level.

 

Element Structure

Elements

NOTE  The above elements must appear in the order shown. If a property is included by both IncludeProperties and IncludeTypes, its inclusion in IncludeProperties takes precedence. If neither IncludeProperties or IncludeTypes is present, it is equivalent to using the following IncludeTypes filter: Singleton* List* EnumOfObject.

Attributes

Attributes Specific to .NET Clients

 

XML Schema

<xsd:complexType name="PropertyFilterType">
   <xsd:sequence>
      <xsd:element maxOccurs="unbounded" minOccurs="0" name="IncludeProperties" type="FilterElementType"/>
      <xsd:element maxOccurs="unbounded" minOccurs="0" name="IncludeTypes" type="FilterElementType"/>
      <xsd:element maxOccurs="unbounded" minOccurs="0" name="ExcludeProperties" type="xsd:string"/>
   </xsd:sequence>
   <xsd:attribute name="maxRecursion" type="xsd:int"/>
   <xsd:attribute name="maxSize" type="xsd:unsignedLong"/>
   <xsd:attribute name="maxElements" type="xsd:int"/>
</xsd:complexType>