OfficeIMO

API Reference

Class

ExcelPivotTableInfo

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Represents an existing pivot table definition.

Inheritance

  • Object
  • ExcelPivotTableInfo

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 requiredposition: 0
cacheId System.UInt32 requiredposition: 1
location System.String requiredposition: 2
sourceSheet System.String requiredposition: 3
sourceRange System.String requiredposition: 4
sheetName System.String requiredposition: 5
sheetIndex System.Int32 requiredposition: 6
pivotStyle System.String requiredposition: 7
layout OfficeIMO.Excel.ExcelPivotLayout requiredposition: 8
dataOnRows System.Nullable{System.Boolean} requiredposition: 9
showHeaders System.Nullable{System.Boolean} requiredposition: 10
showEmptyRows System.Nullable{System.Boolean} requiredposition: 11
showEmptyColumns System.Nullable{System.Boolean} requiredposition: 12
showDrill System.Nullable{System.Boolean} requiredposition: 13
rowFields System.Collections.Generic.IReadOnlyList{System.String} requiredposition: 14
columnFields System.Collections.Generic.IReadOnlyList{System.String} requiredposition: 15
pageFields System.Collections.Generic.IReadOnlyList{System.String} requiredposition: 16
dataFields System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.ExcelPivotDataFieldInfo} requiredposition: 17

Properties

public String Name { get; } #

Gets the pivot table name.

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.