API Reference
ExcelPivotTableInfo
Represents an existing pivot table definition.
Inheritance
- Object
- ExcelPivotTableInfo
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method ExcelDocument.GetPivotTables
- Method ExcelSheet.GetPivotTables
Constructors
public ExcelPivotTableInfo(String name, UInt32 cacheId, String location, String sourceSheet, String sourceRange, String sheetName, Int32 sheetIndex, String pivotStyle, ExcelPivotLayout layout, Nullable<Boolean> dataOnRows, Nullable<Boolean> showHeaders, Nullable<Boolean> showEmptyRows, Nullable<Boolean> showEmptyColumns, Nullable<Boolean> showDrill, IReadOnlyList<String> rowFields, IReadOnlyList<String> columnFields, IReadOnlyList<String> pageFields, IReadOnlyList<ExcelPivotDataFieldInfo> dataFields) #Creates a pivot table info instance.
Parameters
- name System.String
- cacheId System.UInt32
- location System.String
- sourceSheet System.String
- sourceRange System.String
- sheetName System.String
- sheetIndex System.Int32
- pivotStyle System.String
- layout OfficeIMO.Excel.ExcelPivotLayout
- dataOnRows System.Nullable{System.Boolean}
- showHeaders System.Nullable{System.Boolean}
- showEmptyRows System.Nullable{System.Boolean}
- showEmptyColumns System.Nullable{System.Boolean}
- showDrill System.Nullable{System.Boolean}
- rowFields System.Collections.Generic.IReadOnlyList{System.String}
- columnFields System.Collections.Generic.IReadOnlyList{System.String}
- pageFields System.Collections.Generic.IReadOnlyList{System.String}
- dataFields System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.ExcelPivotDataFieldInfo}
Inherited Methods
Properties
public UInt32 CacheId { get; } #Gets the cache id for the pivot table.
public String Location { get; } #Gets the pivot table location (A1 range).
public String SourceSheet { get; } #Gets the source sheet name from the cache.
public String SourceRange { get; } #Gets the source range from the cache.
public String SheetName { get; } #Gets the sheet name where the pivot table is defined.
public Int32 SheetIndex { get; } #Gets the 0-based sheet index where the pivot table is defined.
public String PivotStyle { get; } #Gets the pivot table style name.
public ExcelPivotLayout Layout { get; } #Gets the pivot layout mode.
public Nullable<Boolean> DataOnRows { get; } #Gets whether data fields are shown on rows.
public Nullable<Boolean> ShowHeaders { get; } #Gets whether field headers are shown.
public Nullable<Boolean> ShowEmptyRows { get; } #Gets whether empty rows are shown.
public Nullable<Boolean> ShowEmptyColumns { get; } #Gets whether empty columns are shown.
public Nullable<Boolean> ShowDrill { get; } #Gets whether drill indicators are shown.
public IReadOnlyList<String> RowFields { get; } #Gets row field names.
public IReadOnlyList<String> ColumnFields { get; } #Gets column field names.
public IReadOnlyList<String> PageFields { get; } #Gets page field names.
public IReadOnlyList<ExcelPivotDataFieldInfo> DataFields { get; } #Gets data fields.