CustomFilterCollection
CustomFilterCollection class
Represents the custom filters.
class CustomFilterCollection implements Iterable<CustomFilter>;
Constructors
| Constructor | Description |
|---|---|
| constructor() | Constructs new instance. |
| constructor(Object) | Constructs from an Object convertible to this. |
Properties
| Property | Type | Description |
|---|---|---|
| and | boolean | Indicates whether the two criteria have an “and” relationship. |
Methods
| Method | Description |
|---|---|
| get(number) | Gets the custom filter in the specific index. |
| getAnd() | @deprecated. Please use the ‘and’ property instead. Indicates whether the two criteria have an “and” relationship. |
| setAnd(boolean) | @deprecated. Please use the ‘and’ property instead. Indicates whether the two criteria have an “and” relationship. |
| custom(FilterOperatorType, Object, boolean, FilterOperatorType, Object) | Filters a list with custom criteria. |
| getCount() | @deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in. |
| isNull() | Checks whether the implementation object is null. |
| toObject() | Gets the Object. |
[Symbol.iterator](): Iterator<CustomFilter>
Returns an iterator over the items in the collection. Enables use of for...of, spread syntax, and Array.from().
constructor()
Constructs new instance.
constructor();
Remarks
NOTE: This member is now obsolete. Instead,please set FilterColumn.FilterType as FilterType.CustomFilters then get FilterColumn.CustomFilters. This property will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.
constructor(Object)
Constructs from an Object convertible to this.
constructor(obj: Object);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | Object | The object. |
and
Indicates whether the two criteria have an “and” relationship.
and : boolean;
get(number)
Gets the custom filter in the specific index.
get(index: number) : CustomFilter;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Returns
getAnd()
@deprecated. Please use the ‘and’ property instead. Indicates whether the two criteria have an “and” relationship.
getAnd() : boolean;
setAnd(boolean)
@deprecated. Please use the ‘and’ property instead. Indicates whether the two criteria have an “and” relationship.
setAnd(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
custom(FilterOperatorType, Object, boolean, FilterOperatorType, Object)
Filters a list with custom criteria.
custom(operatorType1: FilterOperatorType, criteria1: Object, isAnd: boolean, operatorType2: FilterOperatorType, criteria2: Object) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| operatorType1 | FilterOperatorType | |
| criteria1 | Object | |
| isAnd | boolean | |
| operatorType2 | FilterOperatorType | |
| criteria2 | Object |
getCount()
@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.
getCount() : number;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
toObject()
Gets the Object.
toObject() : Object;