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