MultipleFilterCollection
MultipleFilterCollection class
Represents the multiple filter collection.
class MultipleFilterCollection implements Iterable<FilterValue>;
Remarks
NOTE: This class is now obsolete. Instead,please use FilterValueCollection instead. This property will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.
Constructors
| Constructor | Description |
|---|---|
| constructor() | Constructs one new instance. |
| constructor(Object) | Constructs from an Object convertible to this. |
Properties
| Property | Type | Description |
|---|---|---|
| count | number | Readonly. Gets the count of the filter values. |
| matchBlank | boolean | Indicates whether to filter by blank. |
Methods
| Method | Description |
|---|---|
| get(number) | Gets DateTimeGroupItem or a string value. |
| getCount() | @deprecated. Please use the ‘count’ property instead. Gets the count of the filter values. |
| getMatchBlank() | @deprecated. Please use the ‘matchBlank’ property instead. Indicates whether to filter by blank. |
| setMatchBlank(boolean) | @deprecated. Please use the ‘matchBlank’ property instead. Indicates whether to filter by blank. |
| add(string) | Adds a label filter criteria. |
| add(DateTimeGroupingType, number, number, number) | Adds a date filter criteria value. |
| add(DateTimeGroupingType, number, number, number, number, number, number) | Adds a date time filter criteria value. |
| getEnumerator() | Get the enumerator for filter value, |
| isNull() | Checks whether the implementation object is null. |
| toObject() | Gets the Object. |
[Symbol.iterator](): Iterator<FilterValue>
Returns an iterator over the items in the collection. Enables use of for...of, spread syntax, and Array.from().
constructor()
Constructs one new instance.
constructor();
Remarks
NOTE: This member is now obsolete. Instead,please set FilterColumn.FilterType as FilterType.MultipleFilters then get FilterColumn.MultipleFilters. 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. |
count
Readonly. Gets the count of the filter values.
count : number;
matchBlank
Indicates whether to filter by blank.
matchBlank : boolean;
get(number)
Gets DateTimeGroupItem or a string value.
get(index: number) : Object;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number |
getCount()
@deprecated. Please use the ‘count’ property instead. Gets the count of the filter values.
getCount() : number;
getMatchBlank()
@deprecated. Please use the ‘matchBlank’ property instead. Indicates whether to filter by blank.
getMatchBlank() : boolean;
setMatchBlank(boolean)
@deprecated. Please use the ‘matchBlank’ property instead. Indicates whether to filter by blank.
setMatchBlank(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
add(string)
Adds a label filter criteria.
add(filter: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| filter | string | The filter data. |
add(DateTimeGroupingType, number, number, number)
Adds a date filter criteria value.
add(type: DateTimeGroupingType, year: number, month: number, day: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | DateTimeGroupingType | The type of date filter. |
| year | number | The year. |
| month | number | The month. |
| day | number | The day. |
add(DateTimeGroupingType, number, number, number, number, number, number)
Adds a date time filter criteria value.
add(type: DateTimeGroupingType, year: number, month: number, day: number, hour: number, minute: number, second: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | DateTimeGroupingType | The type of date filter. |
| year | number | The year. |
| month | number | The month. |
| day | number | The day. |
| hour | number | The hour. |
| minute | number | The minute. |
| second | number | The second. |
getEnumerator()
Get the enumerator for filter value,
getEnumerator() : FilterValueEnumerator;
Returns
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
toObject()
Gets the Object.
toObject() : Object;