PivotField Class

Represents a field in a PivotTable report.
Inheritance Hierarchy
SystemObject
  Aspose.Cells.PivotPivotField

Namespace:  Aspose.Cells.Pivot
Assembly:  Aspose.Cells (in Aspose.Cells.dll) Version: 21.7.0.0 (21.7)
Syntax
public class PivotField

The PivotField type exposes the following members.

Properties
  NameDescription
Public propertyAutoShowCount
Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.
Public propertyAutoShowField
Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.
Public propertyAutoSortField
Represents auto sort field index. -1 means PivotField itself,others means the position of the data fields.
Public propertyBaseFieldIndex
Represents the base field for a custom calculation.
Public propertyBaseIndex
Represents the PivotField index in the base PivotFields.
Public propertyBaseItemIndex
Represents the item in the base field for a custom calculation. Valid only for data fields.
Public propertyBaseItemPosition
Represents the item in the base field for a custom calculation. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute.
Public propertyCurrentPageItem
Represents the current page item showing for the page field (valid only for page fields).
Public propertyDataDisplayFormat
Represents how to display the values contained in a data field.
Public propertyDisplayName
Represents the PivotField display name.
Public propertyDragToColumn
Indicates whether the specified field can be dragged to the column position. The default value is true.
Public propertyDragToData
Indicates whether the specified field can be dragged to the data position. The default value is true.
Public propertyDragToHide
Indicates whether the specified field can be dragged to the hide position. The default value is true.
Public propertyDragToPage
Indicates whether the specified field can be dragged to the page position. The default value is true.
Public propertyDragToRow
Indicates whether the specified field can be dragged to the row position. The default value is true.
Public propertyFunction
Represents the function used to summarize the PivotTable data field.
Public propertyInsertBlankRow
Indicates whether inserting blank line after each item.
Public propertyIsAscendShow
Indicates whether the specified PivotTable field is autoshown ascending.
Public propertyIsAscendSort
Indicates whether the specified PivotTable field is autosorted ascending.
Public propertyIsAutoShow
Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
Public propertyIsAutoSort
Indicates whether the specified PivotTable field is automatically sorted.
Public propertyIsAutoSubtotals
Indicates whether the specified field shows automatic subtotals. Default is true.
Public propertyIsCalculatedField
Indicates whether the specified PivotTable field is calculated field.
Public propertyIsIncludeNewItemsInFilter
indicates whether the field can include new items in manual filter The default value is false.
Public propertyIsInsertPageBreaksBetweenItems
indicates whether the field can insert page breaks between items insert page break after each item The default value is false.
Public propertyIsMultipleItemSelectionAllowed
indicates whether the field can have multiple items selected in the page field The default value is false.
Public propertyIsRepeatItemLabels
indicates whether the field can repeat items labels The default value is false.
Public propertyItemCount
Gets the base item count of this pivot field.
Public propertyItems
Get all base items;
Public propertyName
Represents the PivotField name.
Public propertyNumber
Represents the built-in display format of numbers and dates.
Public propertyNumberFormat
Represents the custom display format of numbers and dates.
Public propertyOriginalItems
Get the original base items;
Public propertyPivotItems
Gets the pivot items of the pivot field
Public propertyPosition
Represents the PivotField index in the PivotFields.
Public propertyRange
Gets the group range of the pivot field
Public propertyShowAllItems
Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. show items with no data The default value is false.
Public propertyShowCompact
Public propertyShowInOutlineForm
Indicates whether layout this field in outline form on the Pivot Table view
Public propertyShowSubtotalAtTop
when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
Methods
  NameDescription
Public methodAddCalculatedItem
Add a calculated item to the pivot field.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetCalculatedFieldFormula
Get the formula string of the specified calculated field .
Public methodGetHashCode (Inherited from Object.)
Public methodGetPivotFilterByType
Gets the pivot filter of the pivot field by type
Public methodGetPivotFilters
Gets the pivot filters of the pivot field
Public methodGetSubtotals
Gets whether the specified field shows that subtotals.
Public methodGetType (Inherited from Object.)
Public methodHideDetail
Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
Public methodHideItem(Int32, Boolean)
Sets whether the specific PivotItem in a data field is hidden.
Public methodHideItem(String, Boolean)
Sets whether the specific PivotItem in a data field is hidden.
Public methodHideItemDetail
Sets whether the specific PivotItem in a pivot field is hidden detail.
Public methodInitPivotItems
Init the pivot items of the pivot field
Public methodIsHiddenItem
Indicates whether the specific PivotItem is hidden.
Public methodIsHiddenItemDetail
Indicates whether the specific PivotItem is hidden detail.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodSetSubtotals
Sets whether the specified field shows that subtotals.
Public methodToString (Inherited from Object.)
See Also