Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

XL.Sheet.AutoFilter.GetCustomFilter

Gets the custom filter criteria.

Component Version macOS Windows Linux Server iOS SDK
XL 7.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.Sheet.AutoFilter.GetCustomFilter"; bookRef; sheetIndex; FilterColumnIndex; Selector )   More

Parameters

Parameter Description Example
bookRef The reference to the workbook. Please use XL.LoadBook to load a file. $ref
sheetIndex The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. 0
FilterColumnIndex The column index of the filter.
Range from 0 to XL.Sheet.AutoFilter.ColumnSize-1.
$FilterColumn
Selector What value to return.
Can be operator1, operator2, andOperator, value1 and value2.
"value1"

Result

Returns value or error.

Description

Gets the custom filter criteria.
Operator1: operator used by the filter comparison in the first filter criteria;
Value1: value used in the first filter criteria;
Operator2: operator used by the filter comparison in the second filter criteria;
Value2: value used in the second filter criteria;
AndOperator: Flag indicating whether the two criteria have an "and" relationship.

See also

This function checks for a license.

Created 1st July 2017, last changed 13th July 2017


XL.Sheet.AutoFilter.FilterType - XL.Sheet.AutoFilter.GetRef