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)

ToggleSyntax

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

Parameters

maxRecursion
Type: System..::.Int32
An int that specifies the maximum allowable recursion depth for property retrieval. This value overrides the global value set by this PropertyFilter object.
maxSize
Type: System..::.Nullable<(Of <(Int64>)>)
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
Type: System..::.Nullable<(Of <(Boolean>)>)
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
Type: System..::.String
A String that specifies a space-separated list of the symbolic names (preferably using PropertyNames constants) of the properties to include.
pageSize
Type: System..::.Nullable<(Of <(Int32>)>)
An Integer that specifies the iterator page size for independent object sets returned by PropertyIndependentObjectSet properties. The iterator page size determines how many elements of an independent object set are retrieved from the server during each fetch. This value overrides the global value set by this PropertyFilter object.

ToggleSee Also