PivotField Class

PivotField class

Represents a field in a PivotTable report.

type PivotField struct  {
	ptr unsafe.Pointer
}

Constructors

Method	Description

Methods

Method	Description
IsNull	Checks whether the implementation object is nullptr.
GetPivotItems	Gets the pivot items of the pivot field
GetGroupSettings	Gets the group settings of the pivot field.
InitPivotItems	Init the pivot items of the pivot field
GroupBy_Double_Bool	Automatically group the field with internal
GroupBy_Date_Date_PivotGroupByTypeArray_Double_Bool	Group the file by the date group types.
GroupBy_Double_Double_Double_Bool	Group the file by number.
GroupBy_CustomPiovtFieldGroupItemArray_Bool	Custom group the field.
Ungroup	Ungroup the pivot field.
GetPivotFilterByType	Gets the pivot filter of the pivot field by type
GetFilters	Gets all pivot filters of this pivot field.
ClearFilter	Clears filter setting on this pivot field.
FilterTop10	Filters by values of data pivot field.
FilterByValue	Filters by values of data pivot field.
FilterByLabel	Filters by captions of row or column pivot field.
FilterByDate	Filters by date setting of row or column pivot field.
IsCalculatedField	Indicates whether the specified PivotTable field is calculated field.
GetFormula	Gets formula of the calculated field .
IsValueFields	Indicates whether this field represents values fields.
GetBaseIndex	Represents the PivotField index in the base PivotFields.
SetBaseIndex	Represents the PivotField index in the base PivotFields.
GetPosition	Represents the index of PivotField in the region.
GetRegionType	Specifies the region of the PivotTable that this field is displayed.
GetName	Represents the name of PivotField.
SetName	Represents the name of PivotField.
GetDisplayName	Represents the PivotField display name.
SetDisplayName	Represents the PivotField display name.
SetSubtotals	Sets whether the specified field shows that subtotals.
GetSubtotals	Indicates whether showing specified subtotal.
IsAutoSubtotals	Indicates whether the specified field shows automatic subtotals. Default is true.
SetIsAutoSubtotals	Indicates whether the specified field shows automatic subtotals. Default is true.
GetDragToColumn	Indicates whether the specified field can be dragged to the column position.The default value is true.
SetDragToColumn	Indicates whether the specified field can be dragged to the column position.The default value is true.
GetDragToHide	Indicates whether the specified field can be dragged to the hide position.The default value is true.
SetDragToHide	Indicates whether the specified field can be dragged to the hide position.The default value is true.
GetDragToRow	Indicates whether the specified field can be dragged to the row position.The default value is true.
SetDragToRow	Indicates whether the specified field can be dragged to the row position.The default value is true.
GetDragToPage	Indicates whether the specified field can be dragged to the page position.The default value is true.
SetDragToPage	Indicates whether the specified field can be dragged to the page position.The default value is true.
GetDragToData	Indicates whether the specified field can be dragged to the data position.The default value is true.
SetDragToData	Indicates whether the specified field can be dragged to the data position.The default value is true.
IsMultipleItemSelectionAllowed	indicates whether the field can have multiple itemsselected in the page fieldThe default value is false.
SetIsMultipleItemSelectionAllowed	indicates whether the field can have multiple itemsselected in the page fieldThe default value is false.
IsRepeatItemLabels	Indicates whether repeating labels of the field in the region.The default value is false.
SetIsRepeatItemLabels	Indicates whether repeating labels of the field in the region.The default value is false.
IsIncludeNewItemsInFilter	Indicates whether including new items to the field in manual filter.The default value is false.
SetIsIncludeNewItemsInFilter	Indicates whether including new items to the field in manual filter.The default value is false.
IsInsertPageBreaksBetweenItems	Indicates whether inserting page breaks after each item.The default value is false.
SetIsInsertPageBreaksBetweenItems	Indicates whether inserting page breaks after each item.The default value is false.
GetShowAllItems	Indicates whether all items displays in the PivotTable report,even if they don’t contain summary data.show items with no dataThe default value is false.
SetShowAllItems	Indicates whether all items displays in the PivotTable report,even if they don’t contain summary data.show items with no dataThe default value is false.
SortBy_SortOrder_Int	Sorts this pivot field.
SortBy_SortOrder_Int_PivotLineType_String	Sorts this pivot field.
GetNonAutoSortDefault	Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.
SetNonAutoSortDefault	Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.
IsAutoSort	Indicates whether the specified PivotTable field is automatically sorted.
SetIsAutoSort	Indicates whether the specified PivotTable field is automatically sorted.
IsAscendSort	Indicates whether the specified PivotTable field is autosorted ascending.
SetIsAscendSort	Indicates whether the specified PivotTable field is autosorted ascending.
GetSortSetting	Gets all settings of auto sorting
GetAutoSortField	Represents the index of field which is auto sorted.-1 means PivotField itself,others means the position of the data fields.
SetAutoSortField	Represents the index of field which is auto sorted.-1 means PivotField itself,others means the position of the data fields.
IsAutoShow	Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
SetIsAutoShow	Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
IsAscendShow	Indicates whether the specified PivotTable field is autoshown ascending.
SetIsAscendShow	Indicates whether the specified PivotTable field is autoshown ascending.
GetAutoShowCount	Represent the number of top or bottom itemsthat are automatically shown in the specified PivotTable field.
SetAutoShowCount	Represent the number of top or bottom itemsthat are automatically shown in the specified PivotTable field.
GetAutoShowField	Represents auto show field index. -1 means PivotField itself.It should be the index of the data fields.
SetAutoShowField	Represents auto show field index. -1 means PivotField itself.It should be the index of the data fields.
GetFunction	Represents the function used to summarize the PivotTable data field.
SetFunction	Represents the function used to summarize the PivotTable data field.
ShowValuesAs	Shows values of data field as different display format when the ShowDataAs calculation is in use.
GetShowValuesSetting	Gets the settings of showing values as when the ShowDataAs calculation is in use.
GetCurrentPageItem	Represents the current page item showing for the page field (valid only for page fields).
SetCurrentPageItem	Represents the current page item showing for the page field (valid only for page fields).
GetNumber	Represents the built-in display format of numbers and dates.
SetNumber	Represents the built-in display format of numbers and dates.
GetInsertBlankRow	Indicates whether inserting blank line after each item.
SetInsertBlankRow	Indicates whether inserting blank line after each item.
GetShowSubtotalAtTop	when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
SetShowSubtotalAtTop	when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
GetShowInOutlineForm	Indicates whether layout this field in outline form on the Pivot Table view
SetShowInOutlineForm	Indicates whether layout this field in outline form on the Pivot Table view
Get_NumberFormat	Represents the custom display format of numbers and dates.
SetNumberFormat	Represents the custom display format of numbers and dates.
IsHiddenItem	Gets whether the specific PivotItem is hidden.
HideItem_Int_Bool	Sets whether the specific PivotItem in a data field is hidden.
IsHiddenItemDetail	Gets whether hidding the detail of the specific PivotItem..
HideItemDetail	Sets whether the specific PivotItem in a pivot field is hidden detail.
HideDetail	Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
HideItem_String_Bool	Sets whether the specific PivotItem in a data field is hidden.
GetItems	Get all labels of pivot items in this field.
GetOriginalItems	Get the original base items;
GetItemCount	Gets the count of the base items in this pivot field.
AddCalculatedItem	Add a calculated formula item to the pivot field.
GetShowCompact	Indicates whether display labels from the next field in the same column on the Pivot Table view
SetShowCompact	Indicates whether display labels from the next field in the same column on the Pivot Table view