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 applied for 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 values of row or column pivot field.
IsCalculatedField	Indicates whether the this pivot field is calculated field.
GetFormula	Gets the formula of the calculated field .Only works for calculated field.
IsValuesField	Indicates whether this field represents values field.
GetBaseIndex	Represents the index in the source pivot fields.
SetBaseIndex	Represents the index in the source pivot fields.
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 display name of pivot field in the pivot table view.
SetDisplayName	Represents the display name of pivot field in the pivot table view.
SetSubtotals	Sets how to subtotal the specified field.
GetSubtotals	Indicates whether to show specified subtotal for this pivot field.
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 region.The default value is true.
SetDragToHide	Indicates whether the specified field can be dragged to the hide region.The default value is true.
GetDragToRow	Indicates whether the specified field can be dragged to the row region.The default value is true.
SetDragToRow	Indicates whether the specified field can be dragged to the row region.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 values region.The default value is true.
SetDragToData	Indicates whether the specified field can be dragged to the values region.The default value is true.
IsMultipleItemSelectionAllowed	Indicates whether multiple items could be selected in the page field.The default value is false.
SetIsMultipleItemSelectionAllowed	Indicates whether multiple items could be selected in the page field.The default value is false.
IsRepeatItemLabels	Indicates whether to repeat labels of the field in the region.The default value is false.
SetIsRepeatItemLabels	Indicates whether to repeat labels of the field in the region.The default value is false.
IsIncludeNewItemsInFilter	Indicates whether to include new items to the field in manual filter.The default value is false.
SetIsIncludeNewItemsInFilter	Indicates whether to include new items to the field in manual filter.The default value is false.
IsInsertPageBreaksBetweenItems	Indicates whether to insert page breaks after each item.The default value is false.
SetIsInsertPageBreaksBetweenItems	Indicates whether to insert page breaks after each item.The default value is false.
GetShowAllItems	Indicates whether to display all items in the PivotTable view,even if they don’t contain summary data.The default value is false.
SetShowAllItems	Indicates whether to display all items in the PivotTable view,even if they don’t contain summary data.The 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 items of this PivotTable field are automatically sorted.
SetIsAutoSort	Indicates whether the items of this PivotTable field are automatically sorted.
IsAscendSort	Indicates whether the items of this pivot field is autosorted ascending.
SetIsAscendSort	Indicates whether the items of this pivot 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.
SetIsAutoShow	Indicates whether the specified PivotTable field is automatically shown.
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 this PivotTable data field.
SetFunction	Represents the function used to summarize this 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 selected page item of the page field to filter data.Only valid for page fields.
SetCurrentPageItem	Represents the current selected page item of the page field to filter data.Only valid for page fields.
GetInsertBlankRow	Indicates whether to insert a blank line after each item.
SetInsertBlankRow	Indicates whether to insert a blank line after each item.
GetShowSubtotalAtTop	Indicates whether to display subtotals at the top or bottom of items when ShowInOutlineForm is true, then
SetShowSubtotalAtTop	Indicates whether to display subtotals at the top or bottom of items when ShowInOutlineForm is true, then
GetShowInOutlineForm	Indicates whether to layout this field in outline form on the Pivot Table view.
SetShowInOutlineForm	Indicates whether to layout this field in outline form on the Pivot Table view.
GetNumber	Represents the built-in display format of numbers and dates.
SetNumber	Represents the built-in display format of numbers and dates.
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 to hide the detail of the specific PivotItem..
HideItemDetail	Sets whether the specific PivotItem in a pivot field is hidden detail.
HideDetail	Sets whether the detail of all PivotItems in a pivot field are hidden.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 to display labels of the next field in the same column on the Pivot Table view
SetShowCompact	Indicates whether to display labels of the next field in the same column on the Pivot Table view