IPivotField Interface

Represents a field in a pivot table report.

Namespace: GrapeCity.Spreadsheet.PivotTables

Assembly: GrapeCity.Spreadsheet.dll

Syntax

public interface IPivotField

Public Interface IPivotField

Properties

Name	Description
AutoSortField	Gets or sets the name of the data field used to sort the specified IPivotTable field automatically.
AutoSortOrder	Gets or sets the order used to sort the specified PivotTable field automatically.
BaseField	Gets the base field for a custom calculation. This property is valid only for data fields.
BaseItem	Gets the item in the base field for a custom calculation. Valid only for data fields.
CalculatedItems	Get an ICalculatedItems object that represents all the calculated items in the specified PivotTable report.
Calculation	Gets or sets the type of calculation performed by the specified field. This property is valid only for data fields.
Caption	Gets or sets a string value that represents the label text for the pivot field.
ChildField	Gets a IPivotField object that represents the child field for the specified field (if the field is grouped and has a child field).
DataType	Gets a PivotFieldDataType value that represents the type of data in the PivotTable field.
EnableMultiplePageItems	Gets or sets a value indicating whether multiple items can be selected in the specified PivotField.
Formula	Gets or sets a value that represents the object's formula in A1-style notation.
Function	Gets or sets the function used to summarize the PivotTable field (data fields only).
GroupLevel	Gets the placement of the specified field within a group of fields (if the field is a member of a grouped set of fields)
HiddenItems	Gets an object that represents either a single hidden PivotTable item or a collection of all the hidden items in the specified field.
IncludeNewItemsInFilter	Gets or sets a value indicating whether excluded or included items should be tracked when manual filtering is applied to the IPivotField.
Index	Gets an integer value that represents the index number of the pivot field within the PivotFields collection.
IsCalculated	Gets a value indicating whether the IPivotField is a calculated field.
LayoutBlankLine	Gets or sets a boolean value indicating whether a blank row is inserted after the specified row field in a PivotTable report.
LayoutCompactRow	Gets or sets a PivotField is compacted (items of multiple PivotFields are displayed in a single column) when rows are selected.
LayoutForm	Returns or sets the way the specified PivotTable items appear—in table format or in outline format.
LayoutSubtotalLocation	Gets or sets the position of the PivotTable field subtotals in relation to (either above or below) the specified field.
Name	Gets a string value representing the name of the object.
NumberFormat	Gets or sets the format code for the PivotTable object.
Orientation	Gets or sets a PivotFieldOrientation value that represents the location of the field in the specified PivotTable report.
ParentField	Gets a IPivotField object that represents the PivotTable field that's the group parent of the specified field. The field must be grouped and must have a parent field.
PivotFilters	Gets the of filters applied to this PivotField.
PivotItems	Gets an object that represents a collection of all the visible and hidden items.
PivotTable	Gets the pivot table that the field belongs to.
Position	Gets a value that represents the position of the field among all the fields in its orientation (Rows, Columns, Pages, Data).
RepeatLabels	Get or sets whether item labels are repeated in the PivotTable for the specified PivotField.
ShowAllItems	Gets or sets a value indicating whether all items in the IPivotTable report are displayed, even if they don't contain summary data.
ShowDetail	Gets or sets whether the specified IPivotField object is showing detail.
SourceName	Gets a string value that represents the specified object's name as it appears in the original source data for the specified IPivotTable object.
SubtotalName	Gets or sets the text string label displayed in the subtotal column or row heading in the specified PivotTable report.
Subtotals	Gets or sets subtotals displayed with the specified field. Valid only for nondata fields.
TotalLevels	Gets the total number of fields in the current field group. If the field isn't grouped, or if the data source is OLAP-based, returns value 1.
VisibleItems	Gets an object that represents a collection of all the visible items.

Methods

Name	Description
AutoGroup()	Automatically groups the pivot fields in a PivotTable.
ClearAllFilters()	Clears all filters applied to the specified PivotField.
ClearLabelFilters()	Clears label filters applied to the specified PivotField.
ClearManualFilter()	Clears manual filters applied to the specified PivotField.
ClearValueFilters()	Clears value filters applied to the specified PivotField.
Delete()	Deletes the specified IPivotField object from the IPivotTable report.
SetBaseField(string)	Sets the base field for a custom calculation. This property is valid only for data fields.
SetBaseItem(string)	Sets the item in the base field for a custom calculation. Valid only for data fields.
UseNextItemAsBase()	Sets the next item in the base field for a custom calculation. Valid only for data fields.
UsePreviousItemAsBase()	Sets the previous item in the base field for a custom calculation. Valid only for data fields.