Skip to main content

GetFilterMode

Returns a value that indicates whether the worksheet has an AutoFilter applied.

Syntax​

expression.GetFilterMode();

expression - A variable that represents a ApiAutoFilter class.

Parameters​

This method doesn't have any parameters.

Returns​

boolean

Example​

This example checks whether a worksheet currently has an AutoFilter.

// How to detect if filtering is active on a sheet.

// Use ApiAutoFilter.GetFilterMode() to test filter state.

let worksheet = Api.GetActiveSheet();

// Initially: no AutoFilter
let autoFilter = worksheet.AutoFilter;

worksheet.GetRange("C1").SetValue("FilterMode before SetAutoFilter:");
worksheet.GetRange("C2").SetValue(autoFilter.FilterMode);

// Add data and apply an AutoFilter
worksheet.GetRange("A1").SetValue("Data");
worksheet.GetRange("A2").SetValue(1);
worksheet.GetRange("A3").SetValue(2);
worksheet.GetRange("A4").SetValue(3);
worksheet.GetRange("A5").SetValue(4);

let dataRange = worksheet.GetRange("A1:A5");
dataRange.SetAutoFilter(1, ">2", "xlOr");

// Reacquire the AutoFilter and check FilterMode again
autoFilter = worksheet.AutoFilter;

worksheet.GetRange("C4").SetValue("FilterMode after SetAutoFilter:");
worksheet.GetRange("C5").SetValue(autoFilter.GetFilterMode());