NOTE: This method is now obsolete.

A pageSize parameter has been added.


Creates a FilterElement object and adds one or more properties to be included during an object retrieval or object refresh.


Namespace: FileNet.Api.Property
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Public Overridable Sub AddIncludeProperty( _ 
   ByVal maxRecursion As Integer,  _ 
   ByVal maxSize As Nullable(Of Long),  _ 
   ByVal levelDependents As Nullable(Of Boolean),  _ 
   ByVal value_Renamed As String _ 
)
C#
public virtual void AddIncludeProperty(
   int maxRecursion,
   Nullable<long> maxSize,
   Nullable<bool> levelDependents,
   string value_Renamed
)
C++
public:
 virtual void AddIncludeProperty(
   int maxRecursion,
   Nullable<long> maxSize,
   Nullable<bool> levelDependents,
   String value_Renamed
)
J#
public virtual void AddIncludeProperty(
   int maxRecursion,
   Nullable<long> maxSize,
   Nullable<bool> levelDependents,
   string value_Renamed
)
JScript
public virtual  function AddIncludeProperty(
   maxRecursion : int,
   maxSize : Nullable<long>,
   levelDependents : Nullable<bool>,
   value_Renamed : String
)

Parameters

maxRecursion
An int that specifies the maximum allowable recursion depth for property retrieval. This value overrides the global value set by this PropertyFilter object.
maxSize
A Long that specifies the maximum size of content data that can be retrieved. This value overrides the global value set by this PropertyFilter object.
levelDependents
A Boolean value of True if the recursion level for a dependent object is the same as that of the independent object to which it belongs; False if one level deeper. This value overrides the global value set by this PropertyFilter object.
value_Renamed
A String that specifies a space-separated list of the symbolic names (preferably using PropertyNames constants) of the properties to include.

See Also