PivotTable Class

PivotTable class

Summary description for PivotTable.

type PivotTable struct  {
	ptr unsafe.Pointer
}

Constructors

Method	Description

Methods

Method	Description
IsNull	Checks whether the implementation object is nullptr.
Dispose	Performs application-defined tasks associated with freeing, releasing, orresetting unmanaged resources.
IsExcel2003Compatible	Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable,if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters,it will be truncated. if false, a string will not have the aforementioned restriction.The default value is true.
SetIsExcel2003Compatible	Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable,if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters,it will be truncated. if false, a string will not have the aforementioned restriction.The default value is true.
GetRefreshedByWho	Gets the name of the last user who refreshed this PivotTable
GetRefreshDate	Gets the last date time when the PivotTable was refreshed.
GetPivotTableStyleName	Gets and sets the pivottable style name.
SetPivotTableStyleName	Gets and sets the pivottable style name.
GetPivotTableStyleType	Gets and sets the built-in pivot table style.
SetPivotTableStyleType	Gets and sets the built-in pivot table style.
CopyStyle	Copies named style from another pivot table.
ShowReportFilterPage	Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
ShowReportFilterPageByName	Show all the report filter pages according to PivotField’s name, the PivotField must be located in the PageFields.
ShowReportFilterPageByIndex	Show all the report filter pages according to the position index in the PageFields
RemoveField_PivotFieldType_String	Removes a field from specific field area
RemoveField_PivotFieldType_Int	Removes a field from specific field area
RemoveField_PivotFieldType_PivotField	Remove field from specific field area
AddFieldToArea_PivotFieldType_String	Adds the field to the specific area.
AddFieldToArea_PivotFieldType_Int	Adds the field to the specific area.
AddFieldToArea_PivotFieldType_PivotField	Adds the field to the specific area.
AddCalculatedField_String_String_Bool	Adds a calculated field to pivot field.
AddCalculatedField_String_String	Adds a calculated field to pivot field and drag it to data area.
GetFields	Gets the specific pivot field list by the region.
GetColumnFields	Returns a PivotFields object that are currently shown as column fields.
GetRowFields	Returns a PivotFields object that are currently shown as row fields.
GetPageFields	Returns a PivotFields object that are currently shown as page fields.
GetDataFields	Gets a PivotField object that represents all the data fields in a PivotTable.Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels.It only use to add DataPivotField to the PivotTable row/column area . Default is in row area.
GetDataField	Gets a PivotField object that represents all the data fields in a PivotTable.Read-only.It would only be created when there are two or more data fields in the Data region.Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method .
GetBaseFields	Returns all base pivot fields in the PivotTable.
GetPivotFilters	Returns all filters of pivot fields in the pivot table.
GetColumnRange	Returns a CellArea object that represents the rangethat contains the column area in the PivotTable report. Read-only.
GetRowRange	Returns a CellArea object that represents the rangethat contains the row area in the PivotTable report. Read-only.
GetDataBodyRange	Returns a CellArea object that represents the range that contains the data areain the list between the header row and the insert row. Read-only.
GetTableRange1	Returns a CellArea object that represents the range containing the entire PivotTable report,but doesn’t include page fields. Read-only.
GetTableRange2	Returns a CellArea object that represents the range containing the entire PivotTable report,includes page fields. Read-only.
MoveTo_Int_Int	Moves the PivotTable to a different location in the worksheet.
MoveTo_String	Moves the PivotTable to a different location in the worksheet.
IsGridDropZones	Indicates whether the PivotTable report displays classic pivottable layout.(enables dragging fields in the grid)
SetIsGridDropZones	Indicates whether the PivotTable report displays classic pivottable layout.(enables dragging fields in the grid)
GetShowColumnGrandTotals	Indicates whether to show grand totals for columns of this pivot table.
SetShowColumnGrandTotals	Indicates whether to show grand totals for columns of this pivot table.
GetShowRowGrandTotals	Indicates whether to show grand totals for rows of the pivot table.
SetShowRowGrandTotals	Indicates whether to show grand totals for rows of the pivot table.
GetDisplayNullString	Indicates whether the PivotTable report displays a custom string if the value is null.
SetDisplayNullString	Indicates whether the PivotTable report displays a custom string if the value is null.
GetNullString	Gets the string displayed in cells that contain null valueswhen the DisplayNullString property is true.The default value is an empty string.
SetNullString	Gets the string displayed in cells that contain null valueswhen the DisplayNullString property is true.The default value is an empty string.
GetDisplayErrorString	Indicates whether the PivotTable report displays a custom string in cells that contain errors.
SetDisplayErrorString	Indicates whether the PivotTable report displays a custom string in cells that contain errors.
GetDataFieldHeaderName	Gets and sets the name of the value area field header in the PivotTable.
SetDataFieldHeaderName	Gets and sets the name of the value area field header in the PivotTable.
GetErrorString	Gets the string displayed in cells that contain errorswhen the DisplayErrorString property is true.The default value is an empty string.
SetErrorString	Gets the string displayed in cells that contain errorswhen the DisplayErrorString property is true.The default value is an empty string.
IsAutoFormat	Indicates whether the PivotTable report is automatically formatted.Checkbox “autoformat table " which is in pivottable option for Excel 2003
SetIsAutoFormat	Indicates whether the PivotTable report is automatically formatted.Checkbox “autoformat table " which is in pivottable option for Excel 2003
GetAutofitColumnWidthOnUpdate	Indicates whether autofitting column width on update
SetAutofitColumnWidthOnUpdate	Indicates whether autofitting column width on update
GetAutoFormatType	Gets and sets the auto format type of PivotTable.
SetAutoFormatType	Gets and sets the auto format type of PivotTable.
GetHasBlankRows	Indicates whether to add blank rows.This property only applies for the PivotTable auto format types which needs to add blank rows.
SetHasBlankRows	Indicates whether to add blank rows.This property only applies for the PivotTable auto format types which needs to add blank rows.
GetMergeLabels	True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.
SetMergeLabels	True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.
GetPreserveFormatting	Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
SetPreserveFormatting	Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
GetShowDrill	Gets and sets whether showing expand/collapse buttons.
SetShowDrill	Gets and sets whether showing expand/collapse buttons.
GetEnableDrilldown	Gets whether drilldown is enabled.
SetEnableDrilldown	Gets whether drilldown is enabled.
GetEnableFieldDialog	Indicates whether the PivotTable Field dialog box is availablewhen the user double-clicks the PivotTable field.
SetEnableFieldDialog	Indicates whether the PivotTable Field dialog box is availablewhen the user double-clicks the PivotTable field.
GetEnableFieldList	Indicates whether the field list for the PivotTable is available on the view of Excel.
SetEnableFieldList	Indicates whether the field list for the PivotTable is available on the view of Excel.
GetEnableWizard	Indicates whether the PivotTable Wizard is available.
SetEnableWizard	Indicates whether the PivotTable Wizard is available.
GetSubtotalHiddenPageItems	Indicates whether hidden page field items in the PivotTable reportare included in row and column subtotals, block totals, and grand totals.The default value is False.
SetSubtotalHiddenPageItems	Indicates whether hidden page field items in the PivotTable reportare included in row and column subtotals, block totals, and grand totals.The default value is False.
GetGrandTotalName	Returns the label that is displayed in the grand total column or row heading.The default value is the string “Grand Total”.
SetGrandTotalName	Returns the label that is displayed in the grand total column or row heading.The default value is the string “Grand Total”.
GetManualUpdate	Indicates whether the PivotTable report is recalculated only at the user’s request.
SetManualUpdate	Indicates whether the PivotTable report is recalculated only at the user’s request.
GetAllowMultipleFiltersPerField	Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
SetAllowMultipleFiltersPerField	Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
GetMissingItemsLimit	Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
SetMissingItemsLimit	Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
GetEnableDataValueEditing	Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable.Enable cell editing in the values area
SetEnableDataValueEditing	Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable.Enable cell editing in the values area
GetShowDataTips	Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
SetShowDataTips	Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
GetShowMemberPropertyTips	Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
SetShowMemberPropertyTips	Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
GetShowValuesRow	Indicates whether showing values row.
SetShowValuesRow	Indicates whether showing values row.
GetShowEmptyCol	Indicates whether to include empty columns in the table
SetShowEmptyCol	Indicates whether to include empty columns in the table
GetShowEmptyRow	Indicates whether to include empty rows in the table.
SetShowEmptyRow	Indicates whether to include empty rows in the table.
GetFieldListSortAscending	Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
SetFieldListSortAscending	Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
GetPrintDrill	Specifies a boolean value that indicates whether drill indicators should be printed.print expand/collapse buttons when displayed on pivottable.
SetPrintDrill	Specifies a boolean value that indicates whether drill indicators should be printed.print expand/collapse buttons when displayed on pivottable.
GetAltTextTitle	Gets and sets the title of the alter text.
SetAltTextTitle	Gets and sets the title of the alter text.
GetAltTextDescription	Gets the description of the alt text.
SetAltTextDescription	Gets the description of the alt text.
GetName	Gets the name of the PivotTable
SetName	Gets the name of the PivotTable
GetColumnHeaderCaption	Gets the Column Header Caption of the PivotTable.
SetColumnHeaderCaption	Gets the Column Header Caption of the PivotTable.
GetIndent	Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
SetIndent	Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
GetRowHeaderCaption	Gets the Row Header Caption of the PivotTable.
SetRowHeaderCaption	Gets the Row Header Caption of the PivotTable.
GetShowRowHeaderCaption	Indicates whether row header caption is shown in the PivotTable reportIndicates whether Display field captions and filter drop downs
SetShowRowHeaderCaption	Indicates whether row header caption is shown in the PivotTable reportIndicates whether Display field captions and filter drop downs
GetCustomListSort	Indicates whether consider built-in custom list when sort data
SetCustomListSort	Indicates whether consider built-in custom list when sort data
GetConditionalFormats	Gets the conditional formats of the pivot table.
GetPageFieldOrder	Gets and sets the order in which page fields are added to the PivotTable report’s layout.
SetPageFieldOrder	Gets and sets the order in which page fields are added to the PivotTable report’s layout.
GetPageFieldWrapCount	Gets the number of page fields in each column or row in the PivotTable report.
SetPageFieldWrapCount	Gets the number of page fields in each column or row in the PivotTable report.
GetTag	Gets a string saved with the PivotTable report.
SetTag	Gets a string saved with the PivotTable report.
GetSaveData	Indicates whether data for the PivotTable report is saved with the workbook.
SetSaveData	Indicates whether data for the PivotTable report is saved with the workbook.
GetRefreshDataOnOpeningFile	Indicates whether Refresh Data when Opening File.
SetRefreshDataOnOpeningFile	Indicates whether Refresh Data when Opening File.
GetSourceType	Gets the data source type of the pivot table.
GetSourceDataConnections	Gets the external connection data sources.
GetNamesOfSourceDataConnections	Gets the name of external source data connections.
GetDataSource	Gets and sets the data source of the pivot table.
SetDataSource	Gets and sets the data source of the pivot table.
ChangeDataSource	Set pivottable’s source data.
GetSource	Get pivottable’s source data.
GetSource_Bool	Get pivottable’s source data.
RefreshData	Refreshes pivottable’s data and setting from it’s data source.
RefreshData_PivotTableRefreshOption	Refreshes pivottable’s data and setting from it’s data source with options.
CalculateData	Calculates pivottable’s data to cells.
CalculateData_PivotTableCalculateOption	Calculating pivot tables with options
ClearData	Clear PivotTable’s data and formatting
CalculateRange	Calculates pivottable’s range.
FormatAll	Format all the cell in the pivottable area
FormatRow	Format the row data in the pivottable area
Format_PivotArea_Style	Formats selected area of the PivotTable.
Format_CellArea_Style	Formats selected area of the PivotTable.
Format_Int_Int_Style	Format the cell in the pivottable area
SelectArea	Select an area of pivot table view.
ShowDetail	Show the detail of one item in the data region to a new Table.
GetPivotFormats	Gets the collection of formats applied to PivotTable.
GetRepeatItemsOnEachPrintedPage	Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
SetRepeatItemsOnEachPrintedPage	Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
GetPrintTitles	Indicates whether the print titles for the worksheet are set basedon the PivotTable report. The default value is false.
SetPrintTitles	Indicates whether the print titles for the worksheet are set basedon the PivotTable report. The default value is false.
GetDisplayImmediateItems	Indicates whether items in the row and column areas are visiblewhen the data area of the PivotTable is empty. The default value is true.
SetDisplayImmediateItems	Indicates whether items in the row and column areas are visiblewhen the data area of the PivotTable is empty. The default value is true.
IsSelected	Indicates whether this PivotTable is selected.
SetIsSelected	Indicates whether this PivotTable is selected.
GetShowPivotStyleRowHeader	Indicates whether the row header in the pivot table should have the style applied.
SetShowPivotStyleRowHeader	Indicates whether the row header in the pivot table should have the style applied.
GetShowPivotStyleColumnHeader	Indicates whether the column header in the pivot table should have the style applied.
SetShowPivotStyleColumnHeader	Indicates whether the column header in the pivot table should have the style applied.
GetShowPivotStyleRowStripes	Indicates whether row stripe formatting is applied.
SetShowPivotStyleRowStripes	Indicates whether row stripe formatting is applied.
GetShowPivotStyleColumnStripes	Indicates whether stripe formatting is applied for column.
SetShowPivotStyleColumnStripes	Indicates whether stripe formatting is applied for column.
GetShowPivotStyleLastColumn	Indicates whether the column formatting is applied.
SetShowPivotStyleLastColumn	Indicates whether the column formatting is applied.
GetHorizontalPageBreaks	Gets horizontal page breaks of this pivot table.
ShowInCompactForm	Layouts the PivotTable in compact form.
ShowInOutlineForm	Layouts the PivotTable in outline form.
ShowInTabularForm	Layouts the PivotTable in tabular form.
GetCellByDisplayName	Gets the Cell object by the display name of PivotField.
GetChildren	Gets the Children Pivot Tables which use this PivotTable data as data source.