Table of Contents

Class XlsPivotTable

Namespace
Spire.Xls.Core.Spreadsheet.PivotTables
Assembly
Spire.XLS.dll
public class XlsPivotTable : XlsObject, IExcelApplication, IDisposable, IPivotTable
Inheritance
XlsPivotTable
Implements
Derived
Inherited Members

Constructors

XlsPivotTable(object, int, IXLSRange) 

public XlsPivotTable(object parent, int cacheIndex, IXLSRange location)

Parameters

parent object
cacheIndex int
location IXLSRange

Properties

AllSubTotalTop

Indicated whether diplay all subtotal at top of group, Change will cover every field's setting

public bool AllSubTotalTop { get; set; }

Property Value

bool

AutoFormatType 

public PivotAutoFomatTypes AutoFormatType { get; set; }

Property Value

PivotAutoFomatTypes

BuiltInStyle 

public PivotBuiltInStyles? BuiltInStyle { get; set; }

Property Value

PivotBuiltInStyles?

Cache 

public PivotCache Cache { get; }

Property Value

PivotCache

CacheIndex 

public int CacheIndex { get; }

Property Value

int

CalculatedFields 

public IPivotCalculatedFields CalculatedFields { get; }

Property Value

IPivotCalculatedFields

ColumnFields 

public IPivotFields ColumnFields { get; }

Property Value

IPivotFields

ColumnsPerPage 

public int ColumnsPerPage { get; set; }

Property Value

int

CustomTableStyleName

Represent the custom Style for this PivotTable

public string CustomTableStyleName { get; set; }

Property Value

string

DataFields 

public PivotDataFields DataFields { get; }

Property Value

PivotDataFields

DisplayErrorString 

public bool DisplayErrorString { get; set; }

Property Value

bool

DisplayFieldCaptions 

public bool DisplayFieldCaptions { get; set; }

Property Value

bool

DisplayNullString 

public bool DisplayNullString { get; set; }

Property Value

bool

EnableDrilldown 

public bool EnableDrilldown { get; set; }

Property Value

bool

EnableFieldDialog 

public bool EnableFieldDialog { get; set; }

Property Value

bool

EnableWizard 

public bool EnableWizard { get; set; }

Property Value

bool

ErrorString 

public string ErrorString { get; set; }

Property Value

string

FirstDataCol

Specifies the first column of the PivotTable data, relative to the top left cell in the ref value

public int FirstDataCol { get; set; }

Property Value

int

FirstDataRow

Specifies the first column of the PivotTable data, relative to the top left cell in the ref value

public int FirstDataRow { get; set; }

Property Value

int

FirstHeaderRow

Specifies the first row of the PivotTable header, relative to the top left cell in the ref value.

public int FirstHeaderRow { get; set; }

Property Value

int

IsColumnGrand 

public bool IsColumnGrand { get; set; }

Property Value

bool

IsCompatibleWithExcel2003 

public bool IsCompatibleWithExcel2003 { get; set; }

Property Value

bool

IsRowGrand 

public bool IsRowGrand { get; set; }

Property Value

bool

Location 

public CellRange Location { get; set; }

Property Value

CellRange

ManualUpdate 

public bool ManualUpdate { get; set; }

Property Value

bool

MergeLabels 

public bool MergeLabels { get; set; }

Property Value

bool

Name 

public string Name { get; set; }

Property Value

string

NullString 

public string NullString { get; set; }

Property Value

string

Options 

public IPivotTableOptions Options { get; }

Property Value

IPivotTableOptions

PageFieldOrder 

public PagesOrderType PageFieldOrder { get; set; }

Property Value

PagesOrderType

PageFieldStyle 

public string PageFieldStyle { get; set; }

Property Value

string

PageFieldWrapCount 

public int PageFieldWrapCount { get; set; }

Property Value

int

PageFields 

public IPivotFields PageFields { get; }

Property Value

IPivotFields

Parent 

public XlsPivotTablesCollection Parent { get; }

Property Value

XlsPivotTablesCollection

PivotConditionalFormats 

public PivotConditionalFormatCollection PivotConditionalFormats { get; }

Property Value

PivotConditionalFormatCollection

PivotFields 

public PivotTableFields PivotFields { get; }

Property Value

PivotTableFields

RepeatItemsOnEachPrintedPage 

public bool RepeatItemsOnEachPrintedPage { get; set; }

Property Value

bool

ReportFilters

Gets or sets report filter collection

public PivotReportFilters ReportFilters { get; set; }

Property Value

PivotReportFilters

RowFields 

public IPivotFields RowFields { get; }

Property Value

IPivotFields

RowsPerPage 

public int RowsPerPage { get; set; }

Property Value

int

ShowColHeaderStyle

Specifies a boolean value that indicates whether to show column headers for the table.

public bool ShowColHeaderStyle { get; set; }

Property Value

bool

ShowColStripes

Specifies a boolean value that indicates whether to show column stripe formatting for the table.

public bool ShowColStripes { get; set; }

Property Value

bool

ShowColumnGrand 

public bool ShowColumnGrand { get; set; }

Property Value

bool

ShowDataFieldInRow

Represents the pivot table to add the Calculated Data field in rows

public bool ShowDataFieldInRow { get; set; }

Property Value

bool

ShowDrillIndicators 

public bool ShowDrillIndicators { get; set; }

Property Value

bool

ShowLastCol

Specifies a boolean value that indicates whether to show the last column.

public bool ShowLastCol { get; set; }

Property Value

bool

ShowRowGrand 

public bool ShowRowGrand { get; set; }

Property Value

bool

ShowRowHeaderStyle

Specifies a boolean value that indicates whether to show row headers for the table.

public bool ShowRowHeaderStyle { get; set; }

Property Value

bool

ShowRowStripes

Specifies a boolean value that indicates whether to show row stripe formatting for the table.

public bool ShowRowStripes { get; set; }

Property Value

bool

ShowSubtotals 

public bool ShowSubtotals { get; set; }

Property Value

bool

Workbook 

public XlsWorkbook Workbook { get; }

Property Value

XlsWorkbook

Worksheet 

public XlsWorksheet Worksheet { get; }

Property Value

XlsWorksheet

Methods

ApplyStyleToRange(IXLSRange, CellStyle)

Apply style to range in pivot table.

public void ApplyStyleToRange(IXLSRange cellRange, CellStyle style)

Parameters

cellRange IXLSRange

Range in pivot table.

style CellStyle

Style that apply to range.

CalculateData() 

public void CalculateData()

ChangeDataSource(IXLSRange)

Change the data source of pivotTable.

public void ChangeDataSource(IXLSRange dataSource)

Parameters

dataSource IXLSRange

New data source range.

Clear() 

public void Clear()

ClearColumnFieldFilter(string) 

public void ClearColumnFieldFilter(string fieldName)

Parameters

fieldName string

ClearFilter(string) 

public void ClearFilter(string fieldName)

Parameters

fieldName string

ClearRowFieldFilter(string) 

public void ClearRowFieldFilter(string fieldName)

Parameters

fieldName string

Clone(object) 

public object Clone(object parent)

Parameters

parent object

Returns

object

Clone(object, int, Dictionary<string, string>) 

public object Clone(object parent, int cacheIndex, Dictionary<string, string> hashWorksheetNames)

Parameters

parent object
cacheIndex int
hashWorksheetNames Dictionary<string, string>

Returns

object