Class ExcelPivotTableFieldFilterCollection

A collection of pivot filters for a pivot table

Inheritance
System.Object
ExcelPivotTableFilterBaseCollection
ExcelPivotTableFieldFilterCollection
Implements
System.Collections.Generic.IEnumerable<ExcelPivotTableFilter>
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.Table.PivotTable.Filter
Assembly: EPPlus.dll
Syntax
public class ExcelPivotTableFieldFilterCollection : ExcelPivotTableFilterBaseCollection, IEnumerable<ExcelPivotTableFilter>, IEnumerable

Methods

AddCaptionFilter(ePivotTableCaptionFilterType, String, String)

Adds a caption (label) filter for a pivot tabel field

Declaration
public ExcelPivotTableFilter AddCaptionFilter(ePivotTableCaptionFilterType type, string value1, string value2 = null)
Parameters
Type Name Description
ePivotTableCaptionFilterType type
System.String value1
System.String value2
Returns
Type Description
ExcelPivotTableFilter

AddDatePeriodFilter(ePivotTableDatePeriodFilterType)

Declaration
public ExcelPivotTableFilter AddDatePeriodFilter(ePivotTableDatePeriodFilterType type)
Parameters
Type Name Description
ePivotTableDatePeriodFilterType type
Returns
Type Description
ExcelPivotTableFilter

AddDateValueFilter(ePivotTableDateValueFilterType, DateTime, Nullable<DateTime>)

Declaration
public ExcelPivotTableFilter AddDateValueFilter(ePivotTableDateValueFilterType type, DateTime value1, DateTime? value2 = null)
Parameters
Type Name Description
ePivotTableDateValueFilterType type
System.DateTime value1
System.Nullable<System.DateTime> value2
Returns
Type Description
ExcelPivotTableFilter

AddTop10Filter(ePivotTableTop10FilterType, ExcelPivotTableDataField, Double, Boolean)

Adds a top 10 filter to the field

Declaration
public ExcelPivotTableFilter AddTop10Filter(ePivotTableTop10FilterType type, ExcelPivotTableDataField dataField, double value, bool isTop = true)
Parameters
Type Name Description
ePivotTableTop10FilterType type

The top-10 filter type
ExcelPivotTableDataField dataField

The datafield within the pivot table
System.Double value

The top or bottom value to relate to
System.Boolean isTop

Top or bottom. true is Top, false is Bottom
Returns
Type Description
ExcelPivotTableFilter

AddTop10Filter(ePivotTableTop10FilterType, Int32, Double, Boolean)

Adds a top 10 filter to the field

Declaration
public ExcelPivotTableFilter AddTop10Filter(ePivotTableTop10FilterType type, int dataFieldIndex, double value, bool isTop = true)
Parameters
Type Name Description
ePivotTableTop10FilterType type

The top-10 filter type
System.Int32 dataFieldIndex

The index to the data field within the pivot tables DataField collection
System.Double value

The top or bottom value to relate to
System.Boolean isTop

Top or bottom. true is Top, false is Bottom
Returns
Type Description
ExcelPivotTableFilter

AddValueFilter(ePivotTableValueFilterType, ExcelPivotTableDataField, Object, Object)

Declaration
public ExcelPivotTableFilter AddValueFilter(ePivotTableValueFilterType type, ExcelPivotTableDataField dataField, object value1, object value2 = null)
Parameters
Type Name Description
ePivotTableValueFilterType type
ExcelPivotTableDataField dataField
System.Object value1
System.Object value2
Returns
Type Description
ExcelPivotTableFilter

AddValueFilter(ePivotTableValueFilterType, Int32, Object, Object)

Declaration
public ExcelPivotTableFilter AddValueFilter(ePivotTableValueFilterType type, int dataFieldIndex, object value1, object value2 = null)
Parameters
Type Name Description
ePivotTableValueFilterType type
System.Int32 dataFieldIndex
System.Object value1
System.Object value2
Returns
Type Description
ExcelPivotTableFilter

Implements

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