跳到主要内容

GetOn

指示此列是否应用了任何筛选器。

当该列存在以下至少一种基础结构时， 该属性为 true：

  • Filters
  • CustomFiltersObj
  • DynamicFilter
  • ColorFilter
  • Top10

语法​

expression.GetOn();

expression - 表示 ApiFilter 类的变量。

参数​

此方法没有任何参数。

返回值​

boolean

示例​

此示例检查列上是否有活动筛选。

// How to see if a given column currently has any filter definition.

// Use ApiFilter.GetOn() to test if a filter is applied.

let worksheet = Api.GetActiveSheet();

// Prepare data
worksheet.GetRange("A1").SetValue("Score");
worksheet.GetRange("A2").SetValue(1);
worksheet.GetRange("A3").SetValue(2);
worksheet.GetRange("A4").SetValue(3);
worksheet.GetRange("A5").SetValue(4);
worksheet.GetRange("A6").SetValue(5);

// Apply a filter on column A
let dataRange = worksheet.GetRange("A1:A6");
dataRange.SetAutoFilter(1, ">2", "xlOr");

// Inspect the filter
let autoFilter = worksheet.AutoFilter;
let filters = autoFilter.Filters;

if (filters.length > 0) {
    let filter = filters[0];

    worksheet.GetRange("C1").SetValue("Filter applied on column A:");
    worksheet.GetRange("D1").SetValue(filter.GetOn());    // or filter.On
}