Class ExcelFilterColumnCollection

Namespace

OfficeOpenXml.Filter

Assembly

EPPlus.dll

A collection of filter columns for an autofilter of table in a worksheet

public class ExcelFilterColumnCollection : XmlHelper, IEnumerable<ExcelFilterColumn>, IEnumerable

Inheritance

object

XmlHelper

ExcelFilterColumnCollection

Implements

IEnumerable<ExcelFilterColumn>

IEnumerable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Count

Number of items in the collection

public int Count { get; }

Property Value

int

this[int]

Indexer of filtercolumns

public ExcelFilterColumn this[int index] { get; }

Parameters

index int

The column index starting from zero

Property Value

ExcelFilterColumn

A filter column

Methods

AddColorFilterColumn(int)

Adds a color filter for the specified column position Note: EPPlus doesn't filter color filters when ApplyFilter is called.

public ExcelColorFilterColumn AddColorFilterColumn(int position)

Parameters

position int

The column position

Returns

ExcelColorFilterColumn

The color filter

AddCustomFilterColumn(int)

Adds a custom filter for the specified column position

public ExcelCustomFilterColumn AddCustomFilterColumn(int position)

Parameters

position int

The column position

Returns

ExcelCustomFilterColumn

The custom filter

AddDynamicFilterColumn(int)

Adds a dynamic filter for the specified column position

public ExcelDynamicFilterColumn AddDynamicFilterColumn(int position)

Parameters

position int

The column position

Returns

ExcelDynamicFilterColumn

The dynamic filter

AddIconFilterColumn(int)

Adds a icon filter for the specified column position Note: EPPlus doesn't filter icon filters when ApplyFilter is called.

public ExcelIconFilterColumn AddIconFilterColumn(int position)

Parameters

position int

The column position

Returns

ExcelIconFilterColumn

The color filter

AddTop10FilterColumn(int)

Adds a top10 filter for the specified column position

public ExcelTop10FilterColumn AddTop10FilterColumn(int position)

Parameters

position int

The column position

Returns

ExcelTop10FilterColumn

The top 10 filter

AddValueFilterColumn(int)

Adds a value filter for the specified column position

public ExcelValueFilterColumn AddValueFilterColumn(int position)

Parameters

position int

The column position

Returns

ExcelValueFilterColumn

The value filter

Clear()

Clear all columns

public void Clear()

GetEnumerator()

Gets the enumerator of the collection

public IEnumerator<ExcelFilterColumn> GetEnumerator()

Returns

IEnumerator<ExcelFilterColumn>

The enumerator

Remove(ExcelFilterColumn)

Remove the filter column from the collection

public void Remove(ExcelFilterColumn column)

Parameters

column ExcelFilterColumn

The column

RemoveAt(int)

Remove the filter column with the position from the collection

public void RemoveAt(int position)

Parameters

position int

The index of the column to remove