WorksheetBase.FilterMode Property


Gets a value that indicates whether the worksheet is actively filtering data.

Namespace:   Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

public bool FilterMode { get; }

Property Value

Type: System.Boolean

true if the worksheet is actively filtering data; otherwise, false.

To determine whether filtering is currently enabled (that is, whether the filter drop-down arrows are displayed on the worksheet), use the AutoFilterMode property.

To enable filtering and create a filtered list, use the M:Microsoft.Office.Interop.Excel.Range.AutoFilter(System.Object,System.Object,Microsoft.Office.Interop.Excel.XlAutoFilterOperator,System.Object,System.Object) method of a Range object, or use the AutoFilter method of a NamedRange object.

This property is true if the worksheet contains a filtered list in which there are hidden rows.

The following code example creates a filtered list of fruits in a Range, and then uses the AutoFilter property to display the filter criteria for the list. The example then prompts the user to turn off the filter by using the AutoFilterMode property, and finally uses the FilterMode property to display whether the worksheet has a filtered list.

This example is for a document-level customization.

private void ActivateAutoFilter()
    this.Range["A1"].Value2 = "Fruits";
    this.Range["A2"].Value2 = "Banana";
    this.Range["A3"].Value2 = "Apple";
    this.Range["A4"].Value2 = "Banana";
    this.Range["A5"].Value2 = "Orange";
    this.Range["A6"].Value2 = "Apple";
    this.Range["A7"].Value2 = "Orange";

    Microsoft.Office.Tools.Excel.NamedRange NamedRange1 =
        this.Controls.AddNamedRange(this.Range["A1", "A7"],

    NamedRange1.AutoFilter(1, "Apple",
       Excel.XlAutoFilterOperator.xlAnd, true);

    MessageBox.Show("The current criteria for the AutoFilter is: " +

    if (this.AutoFilterMode)
        if (DialogResult.Yes == MessageBox.Show("Would you like to " +
            "turn off the filter?", "Example", MessageBoxButtons.YesNo))
            this.AutoFilterMode = false;

    if (this.FilterMode)
        MessageBox.Show("The worksheet has a filtered list.");
        MessageBox.Show("The worksheet does not have a filtered list");
Return to top