IPivotTable Interface

Represents a PivotTable report on a worksheet.

Namespace: GrapeCity.Spreadsheet.PivotTables

Assembly: GrapeCity.Spreadsheet.dll

Syntax

public interface IPivotTable

Public Interface IPivotTable

Properties

Name	Description
AllowMultipleFilters	Gets or sets a boolean value indicating whether a PivotField can have multiple filters applied to it at the same time.
AlternativeText	Gets or sets the descriptive (alternative) text string for the specified PivotTable.
CalculatedFields	A collection of IPivotField objects that represents all the calculated fields in the specified IPivotTable.
ColumnFields	Gets an object that represents a collection of fields in the column area.
ColumnGrand	Gets or sets a boolean value whether the PivotTable report shows grand totals for columns.
CompactLayoutColumnHeader	Specifies the caption that is displayed in the column header of IPivotTable when in compact row layout form.
CompactLayoutRowHeader	Specifies the caption that is displayed in the row header of IPivotTable when in compact row layout form.
CompactRowIndent	Gets or sets the indent increment for PivotItems when compact row layout form is turned on.
DataBodyRange	Gets the range of values in a IPivotTable
DataFields	Gets an object that represents a collection of fields in the values area.
DataOnRows	Gets a value indicating whether multiple data fields in a PivotTable is displayed in Rows field area.
DataPivotField	Gets a IPivotField object that represents all the data fields in a PivotTable.
DeferLayoutUpdate	Gets or sets whether the pivot table defer layout update.
DisplayErrorString	Get or set whether this PivotTable can display the error string. `true` if the PivotTable report displays a custom string in cells that contain error values.
DisplayFieldCaptions	Gets or sets a boolean value indicating whether filter buttons and IPivotField captions for rows and columns are displayed in the grid.
DisplayNullString	Get or set whether this PivotTable can display the null string. `true` if the PivotTable report displays a custom string in cells that contain null values.
ErrorString	Get or sets a String value that represents the string displayed in cells that contain errors when the DisplayErrorString property is `true` .
FieldListSortAscending	Gets or sets a boolean value indicating the sort order of fields in the PivotTable Field List. If FieldListSortAscending is set to `true` the fields are sorted in ascending order; otherwise, the fields are sorted in data source order.
GrandTotalName	Gets or sets the text string label that is displayed in the grand total column or row heading in the specified IPivotTable report.
HasAutoFormat	Get or set a boolean value indicating whether this PivotTable can have auto format. `true` if the PivotTable report is automatically formatted when it’s refreshed or when fields are moved.
Location	Gets or sets the WorksheetReference representing the top-left cell of the specified PivotTable body.
MergeLabels	Get or set a boolean value indicating whether this PivotTable use merged-cell outer-row item, column item, subtotal, and grand total labels. `true` if the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
Name	Get or set a string value representing the name of the object.
NullString	Get or sets the string displayed in cells that contain null values when the DisplayNullString property is `true` .
PageFieldOrder	Gets or sets a Order value indicating the order in which page fields are added to the PivotTable report's layout.
PageFieldWrapCount	Gets or sets the number of page fields in each column or row in the PivotTable report.
PageFields	Gets an object that represents a collection of fields in the filters area.
PivotCache	Gets an IPivotCache object that represents the cache for the specified PivotTable report.
PivotFields	Gets an object that represents a collection of both the visible and hidden fields.
PivotFormulas	Gets a IPivotFormulas object that represents the collection of formulas for the specified PivotTable report.
PrintDrillIndicators	Gets or sets a boolean value whether drill indicators are printed with the PivotTable. If PrintDrillIndicators is set to `true` the drill indicators are printed with the PivotTable; otherwise, drill indicators are not printed with the PivotTable.
RepeatAllLabels	Gets or sets repeat item labels for all PivotFields in the specified PivotTable.
RowAxisLayout	Gets or sets setting layout options for all existing IPivotFields.
RowFields	Gets an object that represents a collection of fields in the row area.
RowGrand	Gets or sets a boolean value whether the PivotTable report shows grand totals for rows.
ShowDrillIndicators	Gets or sets a boolean value indicating the display of drill indicators. If ShowDrillIndicators is set to `true`, drill indicators will be displayed; otherwise, drill indicators will be hidden.
ShowTableStyleColumnHeaders	Gets or sets a boolean value indicating the display of column headers.
ShowTableStyleColumnStripes	Gets or sets a boolean value to display banded columns in which even columns are formatted differently from odd columns. This makes PivotTables easier to read.
ShowTableStyleRowHeaders	Gets or sets a boolean value indicating the display of row headers.
ShowTableStyleRowStripes	Gets or sets a boolean value to display banded rows in which even rows are formatted differently from odd rows. This makes PivotTables easier to read.
ShowValuesRow	Gets or sets whether the values row is displayed.
SubtotalLocation	Sets the subtotal location for all existing PivotFields
Summary	Gets or sets the description associated with the alternative text string for the specified PivotTable
TableRange1	Gets the range containing the entire IPivotTable, but doesn't include page fields.
TableRange2	Gets the range containing the entire IPivotTable
TableStyle	Gets or sets the ITableStyle indicates which PivotTable style currently applied to the IPivotTable.

Methods

Name	Description
AddDataField(IPivotField, string, ConsolidationFunction)	Adds a data field to a IPivotTable report.
ClearAllFilters()	This includes deleting all filters in the PivotFilters collection, removing any manual filtering applied.
Update()	Updates the PivotTable report.