Click or drag to resize

XlsPivotField Class

Represents a pivot field in an Excel pivot table, encapsulating the properties and behaviors of a field within a pivot table.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet.PivotTables XlsPivotField
Spire.Xls PivotField

Namespace: Spire.Xls.Core.Spreadsheet.PivotTables
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
public class XlsPivotField : IPivotField, 
	ICloneParent

The XlsPivotField type exposes the following members.

Constructors
Name Description
Public method XlsPivotField
Initializes a new instance of the XlsPivotField class with the specified parent.
Top
Properties
Name Description
Public property AutoSort
Preserves the sorting elements of the field
Public property Axis
Gets/sets field axis.
Public property CanDragOff
User can remove field from view.
Public property CanDragToColumn
User can drag field to column area.
Public property CanDragToData
True if the specified field can be dragged to the data position. The default value is True.
Public property CanDragToPage
User can drag field to page area.
Public property CanDragToRow
User can drag field to row area.
Public property Caption
Specifies the unique name of the member property to be used as a caption for the field and field items.
Public property Compact
Specifies a boolean value that indicates whether the application will display fields compactly in the sheet on which this PivotTable resides
Public property CustomName
Gets/sets pivot field custom name.
Public property DataField
Gets/sets value indicating whether this is data field.
Public property Formula
Specifies the formula for the calculated field
Public property IsAutoShow
Autoshow is enabled.
Public property IsDataField
Gets/sets value indicating whether this is data field.
Public property IsDragToHide
User can remove field from fiew.
Public property IsFormulaField
Indicates whether this field is formula field
Public property IsMultiSelected
Specifies a boolean value that indicates whether the field can have multiple items selected in the page field.
Public property IsShowAllItems
Show all items for this field.
Public property ItemsPerPage
Specifies the number of items showed per page in the PivotTable.
Public property Name
Returns pivot field name. Read-only.
Public property NumberFormat
Gets/sets number format.
Public property NumberFormatIndex
Gets / sets number format index.
Public property Parent
Gets the parent PivotTableFields object of the current instance.
Public property RepeatItemLabels
True if the field repeat item labels.
Public property ShowBlankRow
True if a blank row is inserted after the specified row field in a PivotTable report.
Public property ShowDataAs
Gets or sets the show data as.
Public property ShowDropDown
True if the flag for the specified PivotTable field or PivotTable item is set to "drilled" (expanded, or visible).
Public property ShowNewItemsInFilter
Specifies a boolean value that indicates whether manual filter is in inclusive mode.
Public property ShowNewItemsOnRefresh
Specifies a boolean value that indicates whether new items that appear after a refresh should be hidden by default.
Public property ShowOutline
Specifies a boolean value that indicates whether the items in this field should be shown in Outline form. If the parameter is true, the field layout is "Show item labels in outline form". If the parameter is false, the field layout is "Show item labels in tabular form".
Public property ShowPageBreak
True if a page break is inserted after each field.
Public property ShowPropAsCaption
Specifies a boolean value that indicates whether to show the property as a member caption.
Public property ShowToolTip
Specifies a boolean value that indicates whether to show the member property value in a tooltip on the appropriate PivotTable cells.
Public property SortType
Specifies the type of sort that is applied to this field.
Public property SubtotalCaption
Specifies the custom text that is displayed for the subtotals caption.
Public property Subtotals
Gets or sets type of field subtotals.
Public property SubtotalTop
Get or set whether show
Top
Methods
Name Description
Public method AddItemOption
Represents the index of item and itemoptions key pairs
Public method AddLabelFilter
Add label filter for pivot field, only for row and column field.
Public method AddValueFilter
Add value filter for pivot field, only for row and column field.
Public method Clone
Creates a new object that is a copy of the current instance.
Public method CreateGroup(DateTime, DateTime, PivotGroupByTypes )
Create group for current field.
Public method CreateGroup(Double, Double, Double)
Create group for current field.
Public method CreateGroup(DateTime, DateTime, PivotGroupByTypes , Int32)
Create group for current field.
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method HideAllItem
Sets whether the all PivotItem in a data field is hidden. Must call after pivottable CalculateData function.
Public method HideDetail
Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field. Must call after pivottable CalculateData function.
Public method HideItem(Int32, Boolean)
Sets whether the specific PivotItem in a data field is hidden. Must call after pivottable CalculateData function.
Public method HideItem(String, Boolean)
Sets whether the specific PivotItem in a data field is hidden. Must call after pivottable CalculateData function.
Public method HideItemDetail(Int32, Boolean)
Sets whether the specific PivotItem in a pivot field is hidden detail. Must call after pivottable CalculateData function.
Public method HideItemDetail(String, Boolean)
Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field. Must call after pivottable CalculateData function.
Public method IsHiddenItem
Indicates whether the specific PivotItem is hidden. Must call after pivottable CalculateData function.
Public method IsHiddenItemDetail
Indicates whether the specific PivotItem is hidden detail. Must call after pivottable CalculateData function.
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Public method Sort
Sort row fildes or col fields by data field.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
See Also