Class ExcelPivotTableAreaStyleCollection

A collection of pivot areas used for styling a pivot table.

Inheritance
System.Object
EPPlusReadOnlyList<ExcelPivotTableAreaStyle>
ExcelPivotTableAreaStyleCollection
Implements
System.Collections.Generic.IEnumerable<ExcelPivotTableAreaStyle>
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
Assembly: EPPlus.dll
Syntax
public class ExcelPivotTableAreaStyleCollection : EPPlusReadOnlyList<ExcelPivotTableAreaStyle>, IEnumerable<ExcelPivotTableAreaStyle>, IEnumerable

Methods

Add()

Adds a pivot area style for labels or data.

Declaration
public ExcelPivotTableAreaStyle Add()
Returns
Type Description
ExcelPivotTableAreaStyle

AddAllData()

Adds a pivot area style that affects all data cells

Declaration
public ExcelPivotTableAreaStyle AddAllData()
Returns
Type Description
ExcelPivotTableAreaStyle

The style object used to set the styles

AddAllLabels()

Adds a pivot area style that affects all labels

Declaration
public ExcelPivotTableAreaStyle AddAllLabels()
Returns
Type Description
ExcelPivotTableAreaStyle

The style object used to set the styles

AddButtonField(ePivotTableAxis, Int32)

Adds a style for filter boxes.

Declaration
public ExcelPivotTableAreaStyle AddButtonField(ePivotTableAxis axis, int index = 0)
Parameters
Type Name Description
ePivotTableAxis axis

The axis for the field buttons
System.Int32 index

The zero-based index in the axis collection
Returns
Type Description
ExcelPivotTableAreaStyle

AddButtonField(ExcelPivotTableField)

Adds a style for the filter box.

Declaration
public ExcelPivotTableAreaStyle AddButtonField(ExcelPivotTableField field)
Parameters
Type Name Description
ExcelPivotTableField field

The field with the box to style
Returns
Type Description
ExcelPivotTableAreaStyle

AddData(ExcelPivotTableField[])

Adds a style for the data area of a pivot table

Declaration
public ExcelPivotTableAreaStyle AddData(params ExcelPivotTableField[] fields)
Parameters
Type Name Description
ExcelPivotTableField[] fields
Returns
Type Description
ExcelPivotTableAreaStyle

AddLabel(ExcelPivotTableField[])

Adds a style for the labels of a pivot table

Declaration
public ExcelPivotTableAreaStyle AddLabel(params ExcelPivotTableField[] fields)
Parameters
Type Name Description
ExcelPivotTableField[] fields

The pivot table field that style affects
Returns
Type Description
ExcelPivotTableAreaStyle

AddTopEnd()

Adds a pivot area style for the top right cells of the pivot table, to the right of any filter button, if reading order i set to Left-To-Right.

Declaration
public ExcelPivotTableAreaStyle AddTopEnd()
Returns
Type Description
ExcelPivotTableAreaStyle

AddTopEnd(String)

Adds a style for the top right cells of the pivot table, to the right of any filter button, if reading order i set to Left-To-Right.

Declaration
public ExcelPivotTableAreaStyle AddTopEnd(string offsetAddress = null)
Parameters
Type Name Description
System.String offsetAddress

Offset address from the top-left cell to the right of any filter button. The top-left cell is refereced as A1. For example, B1:C1 will reference the second and third cell of the first row of the area. "null" will mean all cells
Returns
Type Description
ExcelPivotTableAreaStyle

AddTopStart(String)

Adds a style for the top left cells of the pivot table, if reading order i set to Left-To-Right

Declaration
public ExcelPivotTableAreaStyle AddTopStart(string offsetAddress = null)
Parameters
Type Name Description
System.String offsetAddress

Offset address from the left cell. The top-left cell is refereced as A1. For example, B1:C1 will reference the second and third cell of the first row of the area. "null" will mean all cells
Returns
Type Description
ExcelPivotTableAreaStyle

AddWholeTable()

Adds a pivot area style that affects the whole table.

Declaration
public ExcelPivotTableAreaStyle AddWholeTable()
Returns
Type Description
ExcelPivotTableAreaStyle

The style object used to set the styles

Implements

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