IPivotTable Interface

Represents a PivotTable report on a worksheet. The PivotTable object is a member of the PivotTables collection. The PivotTables collection contains all the PivotTable objects on a single worksheet.

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public interface IPivotTable

Public Interface IPivotTable

Properties

Name	Description
AllowMultipleFilters	Gets or sets a value that indicates whether a PivotField can have multiple filters applied to it at the same time.
CalculatedFields	Returns an ICalculatedFields collection that represents all the calculated fields in the specified PivotTable report.
ColumnFields	Returns an object that represents a collection of all the fields (an IPivotFields object) that are currently shown as column fields. Read-only.
ColumnGrand	Gets or sets whether the PivotTable report shows grand totals for columns (read or write).
ColumnRange	Returns a Range object that represents the range that contains the column area in the PivotTable report (read-only).
CompactRowIndent	Returns or sets the indent increment for PivotItems when compact row layout form is turned on. Read/write.
DataBodyRange	Returns a Range object that represents the range that contains the data area in the list between the header row and the insert row (read-only).
DataFields	Returns an object that represents a collection of all the fields (an IPivotFields object) that are currently shown as data fields. Read-only.
DeferLayoutUpdate	Returns or sets whether the pivotTable defer layout update.
DisplayContextTooltips	Gets or sets whether tooltips are displayed for PivotTable cells (read or write).
DisplayErrorString	True if the PivotTable report displays a custom error string in cells that contain errors. The default value is False.
DisplayFieldCaptions	Gets or sets a value indicating whether filter buttons and PivotField captions for rows and columns are displayed in the grid. Default value is true.
DisplayMemberPropertyTooltips	Gets or sets whether to display member properties in tooltips.
DisplayNullString	True if the PivotTable report displays a custom string in cells that contain null values. The default value is True.
ErrorString	Returns or sets the string displayed in cells that contain errors when the PivotTable.DisplayErrorString property is True. The default value is an empty string (""). Read/write String.
GrandTotalName	Gets or sets the text string label that is displayed in the grand total column or row heading in the specified PivotTable report. The default value is the string "Grand Total".
HasAutoFormat	Gets or sets a value indicating whether the PivotTable report automatically adjusts column width when refreshed. Default is true.
LayoutRowDefault	This property specifies the layout settings for PivotFields when they are added to the PivotTable for the first time.
MergeLabels	True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.
Name	Gets or sets the name of the object.
NullString	Returns or sets the string displayed in cells that contain null values when the PivotTable.DisplayNullString property is True. The default value is an empty string ("").
PageFieldOrder	Returns or sets the order in which page fields are added to the PivotTable report’s layout. Can be one of the following Order constants: DownThenOver or OverThenDown. The default constant is DownThenOver.
PageFieldWrapCount	Returns or sets the number of page fields in each column or row in the PivotTable report.
PageFields	Returns an object that represents a collection of all the fields (an IPivotFields object) that are currently showing as page fields. Read-only.
PageRange	Returns a Range object that represents the range that contains the page area in the PivotTable report.
PivotCache	Returns a PivotCache object that represents the cache for the specified PivotTable report.
PivotColumnAxis	Returns a PivotAxis object representing the entire column axis.
PivotFields	Returns an object that represents either a single PivotTable field (a PivotField object) or a collection of both the visible and hidden fields (a PivotFields object) in the PivotTable report.
PivotFormulas	Returns a PivotFormulas object that represents the collection of formulas for the specified PivotTable report.
PivotRowAxis	Returns a PivotAxis object representing the entire row axis.
RowFields	Returns an object that represents either a collection of all the fields (an IPivotFields object) that are currently showing as row fields. Read-only.
RowGrand	Gets or sets whether the PivotTable report shows grand totals for rows.
RowRange	Returns a Range object that represents the range including the row area on the PivotTable report.
ShowTableStyleColumnHeaders	The PivotTable.ShowTableStyleColumnHeadersproperty is set to True if the coulmn headers should be displayed in the PivotTable.
ShowTableStyleColumnStripes	The Boolean property displays banded columns in which even columns are formatted differently from odd columns. This makes PivotTableseasier to read.
ShowTableStyleLastColumn	The Boolean property displays grand total columns style.
ShowTableStyleRowHeaders	The PivotTable.ShowTableStyleRowHeaders property is set to True if the row headers should be displayed in the PivotTable.
ShowTableStyleRowStripes	The PivotTable.ShowTableStyleRowStripes property displays banded rows in which even rows are formatted differently from odd rows. This makes PivotTables easier to read.
Style	Gets or sets the style currently applied to the specified pivot table.
TableRange1	Returns a Range object that represents the range containing the entire PivotTable report, but doesn’t include page fields.
TableRange2	Returns a Range object that represents the range containing the entire PivotTable report, including page fields.
TableStyle	Gets or sets the style used in the body of the PivotTable report. The default value is a null string (no style is applied by default).
Tag	Gets or sets a string saved with the PivotTable report.

Methods

Name	Description
AddDataField(IPivotField, string, ConsolidationFunction)	Adds a data field to a PivotTable report. Returns a PivotField object that represents the new data field.
ClearAllFilters()	Deletes all filters currently applied to the PivotTable. This includes deleting all filters in the PivotFilters collection of the PivotTable object, removing any manual filtering applied, and setting all PivotFields in the Report Filter area to the default item.
ClearTable()	Clears a PivotTable. Clearing PivotTables includes removing all the fields and deleting all filtering and sorting applied to the PivotTables. This method resets the PivotTable to the state it had right after it was created, before any fields were added to it.
PivotValueCell(int, int)	Retrieve the PivotValueCell object for a given PivotTable provided certain row and column indices.
Refresh()	Refreshes the PivotTable report from the source data. Returns True if it’s successful.
RepeatAllLabels(PivotFieldRepeatLabels)	Sets whether to repeat item labels for all PivotFields in the specified PivotTable.
SetRowAxisLayout(LayoutRowType)	This method is used for simultaneously setting layout options for all existing PivotFields.
SubtotalLocation(SubtotalLocationType)	Changes the subtotal location for all existing PivotFields. Changing the subtotal location has an immediate visual effect only for fields in outline form, but it will be set for fields in tabular form as well.
Update()	Updates the link or PivotTable report.