SearchFilter Class Properties
In this section, the SearchFilter class properties are presented in alphabetical order.
Description
Use this property to set or return a SearchField object.
This property is read/write.
Description
Use this property to return the filter connector (& or |) that is in effect when this search filter is a composite search filter. This property is set by the SearchFilterGenerator class.
This property is effectively read-only.
Description
Use this property to return an array of SearchFilter objects that define this search filter as a composite search filter. This property is set by the SearchFilterGenerator class
This property is effectively read-only.
Description
Use this property to set or return the operator for the filter as a string. Depending on the type of the search attribute, the following operators can be used:
|
Operator |
String |
Number |
Date |
|---|---|---|---|
|
equals |
X |
X |
X |
|
notequals* |
X |
X |
X |
|
contains |
X |
||
|
greaterthan |
X |
X |
|
|
greaterthanequals |
X |
X |
|
|
lessthan |
X |
X |
|
|
lessthanequals |
X |
X |
* The notequals operator can be used when EnableExtendedFilterOperators property is set to true.
This property is read/write.
Description
Use this property to set or return the value for the filter as a string.
This property is read/write.
Use this property only when setting a string or a number (represented as a string) as a filter. If you wish to set a Date or a DateTime value as a filter, use the setDateFilter and setDateTimeFilter methods, respectively