API Reference
Class
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
ExcelPivotTableInfo 3 overloads
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}
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, Nullable<Boolean> rowGrandTotals, Nullable<Boolean> columnGrandTotals, String rowHeaderCaption, String columnHeaderCaption, String grandTotalCaption, String missingCaption, String errorCaption, Nullable<Boolean> showDataDropDown, Nullable<Boolean> showDropZones, Nullable<Boolean> showDataTips, Nullable<Boolean> showMemberPropertyTips, Nullable<Boolean> fieldListSortAscending, Nullable<Boolean> customListSort, IReadOnlyList<String> rowFields, IReadOnlyList<String> columnFields, IReadOnlyList<String> pageFields, IReadOnlyList<ExcelPivotDataFieldInfo> dataFields, IReadOnlyList<ExcelPivotFieldInfo> fields = null) #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}
- rowGrandTotals System.Nullable{System.Boolean}
- columnGrandTotals System.Nullable{System.Boolean}
- rowHeaderCaption System.String
- columnHeaderCaption System.String
- grandTotalCaption System.String
- missingCaption System.String
- errorCaption System.String
- showDataDropDown System.Nullable{System.Boolean}
- showDropZones System.Nullable{System.Boolean}
- showDataTips System.Nullable{System.Boolean}
- showMemberPropertyTips System.Nullable{System.Boolean}
- fieldListSortAscending System.Nullable{System.Boolean}
- customListSort 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}
- fields System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.ExcelPivotFieldInfo} = null
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, Nullable<Boolean> rowGrandTotals, Nullable<Boolean> columnGrandTotals, String rowHeaderCaption, String columnHeaderCaption, String grandTotalCaption, String missingCaption, String errorCaption, Nullable<Boolean> showDataDropDown, Nullable<Boolean> showDropZones, Nullable<Boolean> showDataTips, Nullable<Boolean> showMemberPropertyTips, Nullable<Boolean> fieldListSortAscending, Nullable<Boolean> customListSort, IReadOnlyList<String> rowFields, IReadOnlyList<String> columnFields, IReadOnlyList<String> pageFields, IReadOnlyList<ExcelPivotDataFieldInfo> dataFields, IReadOnlyList<ExcelPivotFieldInfo> fields = null, IReadOnlyList<ExcelPivotFilterInfo> filters = null, IReadOnlyList<ExcelPivotCalculatedFieldInfo> calculatedFields = null, IReadOnlyList<ExcelPivotGroupingInfo> groupings = null) #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}
- rowGrandTotals System.Nullable{System.Boolean}
- columnGrandTotals System.Nullable{System.Boolean}
- rowHeaderCaption System.String
- columnHeaderCaption System.String
- grandTotalCaption System.String
- missingCaption System.String
- errorCaption System.String
- showDataDropDown System.Nullable{System.Boolean}
- showDropZones System.Nullable{System.Boolean}
- showDataTips System.Nullable{System.Boolean}
- showMemberPropertyTips System.Nullable{System.Boolean}
- fieldListSortAscending System.Nullable{System.Boolean}
- customListSort 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}
- fields System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.ExcelPivotFieldInfo} = null
- filters System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.ExcelPivotFilterInfo} = null
- calculatedFields System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.ExcelPivotCalculatedFieldInfo} = null
- groupings System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.ExcelPivotGroupingInfo} = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
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 Nullable<Boolean> RowGrandTotals { get; } #Gets whether row grand totals are shown.
public Nullable<Boolean> ColumnGrandTotals { get; } #Gets whether column grand totals are shown.
public String RowHeaderCaption { get; } #Gets the row header caption.
public String ColumnHeaderCaption { get; } #Gets the column header caption.
public String GrandTotalCaption { get; } #Gets the grand total caption.
public String MissingCaption { get; } #Gets the missing-value caption.
public String ErrorCaption { get; } #Gets the error-value caption.
public Nullable<Boolean> ShowDataDropDown { get; } #Gets whether the data drop-down is shown.
public Nullable<Boolean> ShowDropZones { get; } #Gets whether drop zones are shown.
public Nullable<Boolean> ShowDataTips { get; } #Gets whether data tips are shown.
public Nullable<Boolean> ShowMemberPropertyTips { get; } #Gets whether member-property tips are shown.
public Nullable<Boolean> FieldListSortAscending { get; } #Gets whether the field list sorts ascending.
public Nullable<Boolean> CustomListSort { get; } #Gets whether custom-list sorting is enabled.
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.
public IReadOnlyList<ExcelPivotFieldInfo> Fields { get; } #Gets detailed field metadata.
public IReadOnlyList<ExcelPivotFilterInfo> Filters { get; } #Gets pivot label and value filters.
public IReadOnlyList<ExcelPivotCalculatedFieldInfo> CalculatedFields { get; } #Gets calculated pivot cache fields.
public IReadOnlyList<ExcelPivotGroupingInfo> Groupings { get; } #Gets pivot field grouping metadata.