Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelAutoFilter

OfficeIMO.Excel

Namespace
OfficeIMO.Excel
Assembly
OfficeIMO.Excel
Source revision
e163ccb36643 with working tree changes
Modifiers
sealed

An AutoFilter attached to a worksheet range or its table.

Inheritance

  • object
  • ExcelAutoFilter

Remarks

Get it from ExcelRange.AutoFilter; set criteria per column with ExcelAutoFilter.Column.

Usage

Explore 15 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Methods

public bool Clear() #

Removes the AutoFilter, including its criteria. Returns false when no filter covers the range.

Returns

bool
Column 2 overloads
public ExcelAutoFilterColumn Column(string header) #

Selects the column whose header, in the first row of the filter range, matches header.

Parameters

header string required

Exceptions

  • ArgumentException – No header in the first row of the range matches.
public ExcelAutoFilterColumn Column(uint columnOffset) #

Selects a column by its zero-based offset inside the filter range.

Parameters

columnOffset uint required

Exceptions

  • ArgumentOutOfRangeException – The offset is outside the filter range.
public ExcelAutoFilterInfo? Inspect() #

Reads current criteria and table ownership; returns null after the range's filter is removed.

Properties

public ExcelSheet Sheet { get; } #

Gets the worksheet that owns the filter.

public string Range { get; } #

Gets the A1 range covered by the filter.