Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 700 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Class

ExcelPivotTableInfo

OfficeIMO.Excel

Edit on GitHub
Namespace
OfficeIMO.Excel
Assembly
OfficeIMO.Excel
Source revision
0eef6a5756b9 with working tree changes
Source
ExcelPivotTableInfo.cs:27
Modifiers
sealed

Represents an existing pivot table definition.

Inheritance

  • object
  • ExcelPivotTableInfo

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 2

Constructors

ExcelPivotTableInfo 4 overloads
public ExcelPivotTableInfo(string name, uint cacheId, string? location, string? sourceSheet, string? sourceRange, string sheetName, int sheetIndex, string? pivotStyle, ExcelPivotLayout layout, bool? dataOnRows, bool? showHeaders, bool? showEmptyRows, bool? showEmptyColumns, bool? showDrill, IReadOnlyList<string> rowFields, IReadOnlyList<string> columnFields, IReadOnlyList<string> pageFields, IReadOnlyList<ExcelPivotDataFieldInfo> dataFields) #
ExcelPivotTableInfo.cs:27

Creates a pivot table info instance.

Parameters

name string required
cacheId uint required
location string? required
sourceSheet string? required
sourceRange string? required
sheetName string required
sheetIndex int required
pivotStyle string? required
layout OfficeIMO.Excel.ExcelPivotLayout required
dataOnRows bool? required
showHeaders bool? required
showEmptyRows bool? required
showEmptyColumns bool? required
showDrill bool? required
rowFields System.Collections.Generic.IReadOnlyList<string> required
columnFields System.Collections.Generic.IReadOnlyList<string> required
pageFields System.Collections.Generic.IReadOnlyList<string> required
dataFields System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotDataFieldInfo> required
public ExcelPivotTableInfo(string name, uint cacheId, string? location, string? sourceSheet, string? sourceRange, string sheetName, int sheetIndex, string? pivotStyle, ExcelPivotLayout layout, bool? dataOnRows, bool? showHeaders, bool? showEmptyRows, bool? showEmptyColumns, bool? showDrill, bool? rowGrandTotals, bool? columnGrandTotals, string? rowHeaderCaption, string? columnHeaderCaption, string? grandTotalCaption, string? missingCaption, string? errorCaption, bool? showDataDropDown, bool? showDropZones, bool? showDataTips, bool? showMemberPropertyTips, bool? fieldListSortAscending, bool? customListSort, IReadOnlyList<string> rowFields, IReadOnlyList<string> columnFields, IReadOnlyList<string> pageFields, IReadOnlyList<ExcelPivotDataFieldInfo> dataFields, IReadOnlyList<ExcelPivotFieldInfo>? fields = null) #
ExcelPivotTableInfo.cs:68

Creates a pivot table info instance.

Parameters

name string required
cacheId uint required
location string? required
sourceSheet string? required
sourceRange string? required
sheetName string required
sheetIndex int required
pivotStyle string? required
layout OfficeIMO.Excel.ExcelPivotLayout required
dataOnRows bool? required
showHeaders bool? required
showEmptyRows bool? required
showEmptyColumns bool? required
showDrill bool? required
rowGrandTotals bool? required
columnGrandTotals bool? required
rowHeaderCaption string? required
columnHeaderCaption string? required
grandTotalCaption string? required
missingCaption string? required
errorCaption string? required
showDataDropDown bool? required
showDropZones bool? required
showDataTips bool? required
showMemberPropertyTips bool? required
fieldListSortAscending bool? required
customListSort bool? required
rowFields System.Collections.Generic.IReadOnlyList<string> required
columnFields System.Collections.Generic.IReadOnlyList<string> required
pageFields System.Collections.Generic.IReadOnlyList<string> required
dataFields System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotDataFieldInfo> required
fields System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotFieldInfo>? = null optional
public ExcelPivotTableInfo(string name, uint cacheId, string? location, string? sourceSheet, string? sourceRange, string sheetName, int sheetIndex, string? pivotStyle, ExcelPivotLayout layout, bool? dataOnRows, bool? showHeaders, bool? showEmptyRows, bool? showEmptyColumns, bool? showDrill, bool? rowGrandTotals, bool? columnGrandTotals, string? rowHeaderCaption, string? columnHeaderCaption, string? grandTotalCaption, string? missingCaption, string? errorCaption, bool? showDataDropDown, bool? showDropZones, bool? showDataTips, bool? showMemberPropertyTips, bool? fieldListSortAscending, bool? 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, bool? refreshOnOpen = null, bool? saveSourceData = null, bool? preserveFormatting = null, bool? enableDrill = null) #
ExcelPivotTableInfo.cs:118

Creates a pivot table info instance.

Parameters

name string required
cacheId uint required
location string? required
sourceSheet string? required
sourceRange string? required
sheetName string required
sheetIndex int required
pivotStyle string? required
layout OfficeIMO.Excel.ExcelPivotLayout required
dataOnRows bool? required
showHeaders bool? required
showEmptyRows bool? required
showEmptyColumns bool? required
showDrill bool? required
rowGrandTotals bool? required
columnGrandTotals bool? required
rowHeaderCaption string? required
columnHeaderCaption string? required
grandTotalCaption string? required
missingCaption string? required
errorCaption string? required
showDataDropDown bool? required
showDropZones bool? required
showDataTips bool? required
showMemberPropertyTips bool? required
fieldListSortAscending bool? required
customListSort bool? required
rowFields System.Collections.Generic.IReadOnlyList<string> required
columnFields System.Collections.Generic.IReadOnlyList<string> required
pageFields System.Collections.Generic.IReadOnlyList<string> required
dataFields System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotDataFieldInfo> required
fields System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotFieldInfo>? = null optional
filters System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotFilterInfo>? = null optional
calculatedFields System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotCalculatedFieldInfo>? = null optional
groupings System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotGroupingInfo>? = null optional
refreshOnOpen bool? = null optional
saveSourceData bool? = null optional
preserveFormatting bool? = null optional
enableDrill bool? = null optional
public ExcelPivotTableInfo(string name, uint cacheId, string? location, string? sourceSheet, string? sourceRange, string sheetName, int sheetIndex, string? pivotStyle, ExcelPivotLayout layout, bool? dataOnRows, bool? showHeaders, bool? showEmptyRows, bool? showEmptyColumns, bool? showDrill, bool? rowGrandTotals, bool? columnGrandTotals, string? rowHeaderCaption, string? columnHeaderCaption, string? grandTotalCaption, string? missingCaption, string? errorCaption, bool? showDataDropDown, bool? showDropZones, bool? showDataTips, bool? showMemberPropertyTips, bool? fieldListSortAscending, bool? customListSort, IReadOnlyList<string> rowFields, IReadOnlyList<string> columnFields, IReadOnlyList<string> pageFields, IReadOnlyList<ExcelPivotDataFieldInfo> dataFields, IReadOnlyList<ExcelPivotFieldInfo>? fields, IReadOnlyList<ExcelPivotFilterInfo>? filters, IReadOnlyList<ExcelPivotCalculatedFieldInfo>? calculatedFields, IReadOnlyList<ExcelPivotGroupingInfo>? groupings, bool? refreshOnOpen, bool? saveSourceData, bool? preserveFormatting, bool? enableDrill, bool hasValuesAxisField) #
ExcelPivotTableInfo.cs:128

Creates a pivot table info instance with Values-axis detection.

Parameters

name string required
cacheId uint required
location string? required
sourceSheet string? required
sourceRange string? required
sheetName string required
sheetIndex int required
pivotStyle string? required
layout OfficeIMO.Excel.ExcelPivotLayout required
dataOnRows bool? required
showHeaders bool? required
showEmptyRows bool? required
showEmptyColumns bool? required
showDrill bool? required
rowGrandTotals bool? required
columnGrandTotals bool? required
rowHeaderCaption string? required
columnHeaderCaption string? required
grandTotalCaption string? required
missingCaption string? required
errorCaption string? required
showDataDropDown bool? required
showDropZones bool? required
showDataTips bool? required
showMemberPropertyTips bool? required
fieldListSortAscending bool? required
customListSort bool? required
rowFields System.Collections.Generic.IReadOnlyList<string> required
columnFields System.Collections.Generic.IReadOnlyList<string> required
pageFields System.Collections.Generic.IReadOnlyList<string> required
dataFields System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotDataFieldInfo> required
fields System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotFieldInfo>? required
filters System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotFilterInfo>? required
calculatedFields System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotCalculatedFieldInfo>? required
groupings System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelPivotGroupingInfo>? required
refreshOnOpen bool? required
saveSourceData bool? required
preserveFormatting bool? required
enableDrill bool? required
hasValuesAxisField bool required

Properties

public string Name { get; } #
ExcelPivotTableInfo.cs:215

Gets the pivot table name.

public uint CacheId { get; } #
ExcelPivotTableInfo.cs:220

Gets the cache id for the pivot table.

public string? Location { get; } #
ExcelPivotTableInfo.cs:225

Gets the pivot table location (A1 range).

public string? SourceSheet { get; } #
ExcelPivotTableInfo.cs:230

Gets the source sheet name from the cache.

public string? SourceRange { get; } #
ExcelPivotTableInfo.cs:235

Gets the source range from the cache.

public string SheetName { get; } #
ExcelPivotTableInfo.cs:240

Gets the sheet name where the pivot table is defined.

public int SheetIndex { get; } #
ExcelPivotTableInfo.cs:245

Gets the 0-based sheet index where the pivot table is defined.

public string? PivotStyle { get; } #
ExcelPivotTableInfo.cs:250

Gets the pivot table style name.

public ExcelPivotLayout Layout { get; } #
ExcelPivotTableInfo.cs:255

Gets the pivot layout mode.

public bool? DataOnRows { get; } #
ExcelPivotTableInfo.cs:260

Gets whether data fields are shown on rows.

public bool? ShowHeaders { get; } #
ExcelPivotTableInfo.cs:265

Gets whether field headers are shown.

public bool? ShowEmptyRows { get; } #
ExcelPivotTableInfo.cs:270

Gets whether empty rows are shown.

public bool? ShowEmptyColumns { get; } #
ExcelPivotTableInfo.cs:275

Gets whether empty columns are shown.

public bool? ShowDrill { get; } #
ExcelPivotTableInfo.cs:280

Gets whether drill indicators are shown.

public bool? RowGrandTotals { get; } #
ExcelPivotTableInfo.cs:285

Gets whether row grand totals are shown.

public bool? ColumnGrandTotals { get; } #
ExcelPivotTableInfo.cs:290

Gets whether column grand totals are shown.

public string? RowHeaderCaption { get; } #
ExcelPivotTableInfo.cs:295

Gets the row header caption.

public string? ColumnHeaderCaption { get; } #
ExcelPivotTableInfo.cs:300

Gets the column header caption.

public string? GrandTotalCaption { get; } #
ExcelPivotTableInfo.cs:305

Gets the grand total caption.

public string? MissingCaption { get; } #
ExcelPivotTableInfo.cs:310

Gets the missing-value caption.

public string? ErrorCaption { get; } #
ExcelPivotTableInfo.cs:315

Gets the error-value caption.

public bool? ShowDataDropDown { get; } #
ExcelPivotTableInfo.cs:320

Gets whether the data drop-down is shown.

public bool? ShowDropZones { get; } #
ExcelPivotTableInfo.cs:325

Gets whether drop zones are shown.

public bool? ShowDataTips { get; } #
ExcelPivotTableInfo.cs:330

Gets whether data tips are shown.

public bool? ShowMemberPropertyTips { get; } #
ExcelPivotTableInfo.cs:335

Gets whether member-property tips are shown.

public bool? FieldListSortAscending { get; } #
ExcelPivotTableInfo.cs:340

Gets whether the field list sorts ascending.

public bool? CustomListSort { get; } #
ExcelPivotTableInfo.cs:345

Gets whether custom-list sorting is enabled.

public bool? RefreshOnOpen { get; } #
ExcelPivotTableInfo.cs:350

Gets whether Excel should refresh the pivot cache when the workbook opens.

public bool? SaveSourceData { get; } #
ExcelPivotTableInfo.cs:355

Gets whether source cache records are saved in the workbook package.

public bool? PreserveFormatting { get; } #
ExcelPivotTableInfo.cs:360

Gets whether pivot formatting is preserved during refreshes.

public bool? EnableDrill { get; } #
ExcelPivotTableInfo.cs:365

Gets whether pivot detail drill interaction is enabled.

public IReadOnlyList<string> RowFields { get; } #
ExcelPivotTableInfo.cs:370

Gets row field names.

public IReadOnlyList<string> ColumnFields { get; } #
ExcelPivotTableInfo.cs:375

Gets column field names.

public IReadOnlyList<string> RowSourceFields { get; internal set; } #
ExcelPivotTableInfo.cs:377

Source fields on the row axis, excluding the Values pseudo-field.

public IReadOnlyList<string> ColumnSourceFields { get; internal set; } #
ExcelPivotTableInfo.cs:379

Source fields on the column axis, excluding the Values pseudo-field.

public ExcelPivotTableAxis? ValuesAxis { get; internal set; } #
ExcelPivotTableInfo.cs:381

Axis containing exactly one Values pseudo-field, or null when absent or ambiguous.

public int? ValuesAxisPosition { get; internal set; } #
ExcelPivotTableInfo.cs:383

Zero-based position of the Values pseudo-field within its axis, or null when absent or ambiguous.

public bool HasValuesAxisField { get; } #
ExcelPivotTableInfo.cs:386

Whether a row or column axis includes Excel's synthetic Values field.

public IReadOnlyList<string> PageFields { get; } #
ExcelPivotTableInfo.cs:391

Gets page field names.

public IReadOnlyList<ExcelPivotDataFieldInfo> DataFields { get; } #
ExcelPivotTableInfo.cs:396

Gets data fields.

public IReadOnlyList<ExcelPivotFieldInfo> Fields { get; } #
ExcelPivotTableInfo.cs:401

Gets detailed field metadata.

public IReadOnlyList<ExcelPivotFilterInfo> Filters { get; } #
ExcelPivotTableInfo.cs:406

Gets pivot label and value filters.

public IReadOnlyList<ExcelPivotCalculatedFieldInfo> CalculatedFields { get; } #
ExcelPivotTableInfo.cs:411

Gets calculated pivot cache fields.

public IReadOnlyList<ExcelPivotGroupingInfo> Groupings { get; } #
ExcelPivotTableInfo.cs:416

Gets pivot field grouping metadata.