Class ExcelFilterColumnCollection

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

Inheritance
System.Object
XmlHelper
ExcelFilterColumnCollection
Implements
System.Collections.Generic.IEnumerable<ExcelFilterColumn>
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: OfficeOpenXml.Filter
Assembly: EPPlus.dll
Syntax
public class ExcelFilterColumnCollection : XmlHelper, IEnumerable<ExcelFilterColumn>, IEnumerable

Properties

Count

Number of items in the collection

Declaration
public int Count { get; }
Property Value
Type Description
System.Int32

Item[Int32]

Indexer of filtercolumns

Declaration
public ExcelFilterColumn this[int index] { get; }
Parameters
Type Name Description
System.Int32 index

The column index starting from zero
Property Value
Type Description
ExcelFilterColumn

A filter column

Methods

AddColorFilterColumn(Int32)

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

Declaration
public ExcelColorFilterColumn AddColorFilterColumn(int position)
Parameters
Type Name Description
System.Int32 position

The column position
Returns
Type Description
ExcelColorFilterColumn

The color filter

AddCustomFilterColumn(Int32)

Adds a custom filter for the specified column position

Declaration
public ExcelCustomFilterColumn AddCustomFilterColumn(int position)
Parameters
Type Name Description
System.Int32 position

The column position
Returns
Type Description
ExcelCustomFilterColumn

The custom filter

AddDynamicFilterColumn(Int32)

Adds a dynamic filter for the specified column position

Declaration
public ExcelDynamicFilterColumn AddDynamicFilterColumn(int position)
Parameters
Type Name Description
System.Int32 position

The column position
Returns
Type Description
ExcelDynamicFilterColumn

The dynamic filter

AddIconFilterColumn(Int32)

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

Declaration
public ExcelIconFilterColumn AddIconFilterColumn(int position)
Parameters
Type Name Description
System.Int32 position

The column position
Returns
Type Description
ExcelIconFilterColumn

The color filter

AddTop10FilterColumn(Int32)

Adds a top10 filter for the specified column position

Declaration
public ExcelTop10FilterColumn AddTop10FilterColumn(int position)
Parameters
Type Name Description
System.Int32 position

The column position
Returns
Type Description
ExcelTop10FilterColumn

The top 10 filter

AddValueFilterColumn(Int32)

Adds a value filter for the specified column position

Declaration
public ExcelValueFilterColumn AddValueFilterColumn(int position)
Parameters
Type Name Description
System.Int32 position

The column position
Returns
Type Description
ExcelValueFilterColumn

The value filter

GetEnumerator()

Gets the enumerator of the collection

Declaration
public IEnumerator<ExcelFilterColumn> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<ExcelFilterColumn>

The enumerator

Remove(ExcelFilterColumn)

Remove the filter column from the collection

Declaration
public void Remove(ExcelFilterColumn column)
Parameters
Type Name Description
ExcelFilterColumn column

The column

RemoveAt(Int32)

Remove the filter column with the position from the collection

Declaration
public void RemoveAt(int position)
Parameters
Type Name Description
System.Int32 position

The index of the column to remove

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Gets the enumerator for the collection

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

The enumerator

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable