Creates a FilterElement object that specifies, either by identifier or by
type, one or more properties to retrieve from the server.
Namespace:
FileNet.Api.Property
Assembly:
FileNet.Api (in FileNet.Api.dll)
Visual Basic (Declaration) |
---|
Public Sub New ( _
maxRecursion As Nullable(Of Integer), _
maxSize As Nullable(Of Long), _
levelDependents As Nullable(Of Boolean), _
value_Renamed As String, _
pageSize As Nullable(Of Integer) _
) |
C# |
---|
public FilterElement(
Nullable<int> maxRecursion,
Nullable<long> maxSize,
Nullable<bool> levelDependents,
string value_Renamed,
Nullable<int> pageSize
) |
Visual C++ |
---|
public:
FilterElement(
Nullable<int> maxRecursion,
Nullable<long long> maxSize,
Nullable<bool> levelDependents,
String^ value_Renamed,
Nullable<int> pageSize
) |
JavaScript |
---|
FileNet.Api.Property.FilterElement = function(maxRecursion, maxSize, levelDependents, value_Renamed, pageSize); |
Parameters
- maxRecursion
- Type: System..::.Nullable<(Of <(Int32>)>)
A zero-based Integer that specifies the maximum
allowable recursion depth to use when retrieving property relationships. If
unspecified, the default is zero.
- maxSize
- Type: System..::.Nullable<(Of <(Int64>)>)
A Long that specifies the maximum size, in bytes,
of content data that can be returned when properties that hold content data are
retrieved. If the amount of content data held by retrieved properties exceeds
this size, no content data is returned.
- levelDependents
- Type: System..::.Nullable<(Of <(Boolean>)>)
A Boolean that specifies whether the
recursion level to use when retrieving a dependent object is the same as that
of the independent object to which it belongs (True) or one level deeper
(False).
- value_Renamed
- Type: System..::.String
A String specifying one or more properties to
retrieve. You can either specify a space-separated list of property names or property types,
but not both. To specify property names, construct a space-separated list of each property's
symbolic name (preferably using PropertyNames constants). Although you can
alternatively specify a property by its assigned GUID, it is not recommended.
To specify property types, construct a space-separated list in which each property type is in
one of the following formats (note that you can mix formats within the same string):
-
"SingletonBoolean": All PropertyBoolean properties.
-
"SingletonBinary": All PropertyBinary properties.
-
"SingletonDateTime": All PropertyDateTime properties.
-
"SingletonFloat64": All PropertyFloat64 properties.
-
"SingletonId": All PropertyId properties.
-
"SingletonInteger32": All PropertyInteger32 properties.
-
"SingletonObject": All PropertyEngineObject properties.
-
"SingletonString": All PropertyString properties.
-
"ContentData": All PropertyContent properties.
-
"ListOfBoolean": All PropertyBooleanList properties.
-
"ListOfBinary": All PropertyBinaryList properties.
-
"ListOfDateTime": All PropertyDateTimeList properties.
-
"ListOfFloat64": All PropertyFloat64List properties.
-
"ListOfId": All PropertyIdList properties.
-
"ListOfInteger32": All PropertyInteger32List properties.
-
"ListOfObject": All PropertyDependentObjectList properties.
-
"ListOfString": All PropertyStringList properties.
-
"EnumOfObject": All PropertyIndependentObjectSet properties.
-
"Singleton*": All single-valued properties.
-
"List*": All list-value properties (does not include "EnumOfObject" properties).
-
"!Object": All properties that do not return object values.
-
"*": All properties.
- 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.