asposecells.api
Class PivotTable

Summary description for PivotTable.

Property Getters/Setters Summary
methodgetAltTextDescription()
methodsetAltTextDescription(value)
           Gets the description of the alt text
methodgetAltTextTitle()
methodsetAltTextTitle(value)
           Gets the title of the alttext
methodgetAutoFormatType()
methodsetAutoFormatType(value)
           Gets the PivotTable auto format type. The value of the property is PivotTableAutoFormatType integer constant.
methodgetBaseFields()
           Returns a PivotFields object that includes all fields in the PivotTable report
methodgetColumnFields()
           Returns a PivotFields object that are currently shown as column fields.
methodgetColumnGrand()
methodsetColumnGrand(value)
           Indicates whether the PivotTable report shows grand totals for columns.
methodgetColumnHeaderCaption()
methodsetColumnHeaderCaption(value)
           Gets the Column Header Caption of the PivotTable.
methodgetColumnRange()
           Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
methodgetCustomListSort()
methodsetCustomListSort(value)
           Indicates whether consider built-in custom list when sort data
methodgetDataBodyRange()
           Returns a CellArea object that represents the range that contains the data area in the list between the header row and the insert row. Read-only.
methodgetDataField()
           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.
methodgetDataFields()
           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.
methodgetDataSource()
methodsetDataSource(value)
           Gets and sets the data source of the pivot table.
methodgetDisplayErrorString()
methodsetDisplayErrorString(value)
           Indicates whether the PivotTable report displays a custom string in cells that contain errors.
methodgetDisplayImmediateItems()
methodsetDisplayImmediateItems(value)
           Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty. The default value is true.
methodgetDisplayNullString()
methodsetDisplayNullString(value)
           Indicates whether the PivotTable report displays a custom string in cells that contain null values.
methodgetEnableDataValueEditing()
methodsetEnableDataValueEditing(value)
           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
methodgetEnableDrilldown()
methodsetEnableDrilldown(value)
           Gets whether drilldown is enabled.
methodgetEnableFieldDialog()
methodsetEnableFieldDialog(value)
           Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
methodgetEnableFieldList()
methodsetEnableFieldList(value)
           Gets whether enable the field list for the PivotTable.
methodgetEnableWizard()
methodsetEnableWizard(value)
           Indicates whether the PivotTable Wizard is available.
methodgetErrorString()
methodsetErrorString(value)
           Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
methodgetFieldListSortAscending()
methodsetFieldListSortAscending(value)
           Specifies a boolean value that indicates whether fields in the PivotTable are sorted in non-default order in the field list.
methodgetGrandTotalName()
methodsetGrandTotalName(value)
           Returns the text string label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".
methodhasBlankRows()
methodsetHasBlankRows(value)
           Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
methodgetIndent()
methodsetIndent(value)
           Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
methodisAutoFormat()
methodsetAutoFormat(value)
           Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table "which in pivottable option for Excel 2003 Checkbox "autofit column width on update"which in pivot table Options :Layout Format for Excel 2007
methodisExcel2003Compatible()
methodsetExcel2003Compatible(value)
           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.
methodisGridDropZones()
methodsetGridDropZones(value)
           Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
methodisMultipleFieldFilters()
methodsetMultipleFieldFilters(value)
           Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
methodisSelected()
methodsetSelected(value)
           Indicates whether the PivotTable is selected.
methodgetItemPrintTitles()
methodsetItemPrintTitles(value)
           A bit that specifies whether pivot item captions on the row axis are repeated on each printed page for pivot fields in tabular form.
methodgetManualUpdate()
methodsetManualUpdate(value)
           Indicates whether the PivotTable report is recalculated only at the user's request.
methodgetMergeLabels()
methodsetMergeLabels(value)
           Indicates whether the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
methodgetMissingItemsLimit()
methodsetMissingItemsLimit(value)
           Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. The value of the property is PivotMissingItemLimitType integer constant.
methodgetName()
methodsetName(value)
           Gets the name of the PivotTable
methodgetNullString()
methodsetNullString(value)
           Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
methodgetPageFieldOrder()
methodsetPageFieldOrder(value)
           Gets the order in which page fields are added to the PivotTable report's layout. The value of the property is PrintOrderType integer constant.
methodgetPageFields()
           Returns a PivotFields object that are currently shown as page fields.
methodgetPageFieldWrapCount()
methodsetPageFieldWrapCount(value)
           Gets the number of page fields in each column or row in the PivotTable report.
methodgetPivotFilters()
           Returns a PivotFilterCollection object.
methodgetPivotFormatConditions()
           Gets the Format Conditions of the pivot table.
methodgetPivotTableStyleName()
methodsetPivotTableStyleName(value)
           Gets and sets the pivottable style name.
methodgetPivotTableStyleType()
methodsetPivotTableStyleType(value)
           Gets and sets the built-in pivot table style. The value of the property is PivotTableStyleType integer constant.
methodgetPreserveFormatting()
methodsetPreserveFormatting(value)
           Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
methodgetPrintDrill()
methodsetPrintDrill(value)
           Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
methodgetPrintTitles()
methodsetPrintTitles(value)
           Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
methodgetRefreshDataFlag()
methodsetRefreshDataFlag(value)
           Indicates whether Refresh Data or not.
methodgetRefreshDataOnOpeningFile()
methodsetRefreshDataOnOpeningFile(value)
           Indicates whether Refresh Data when Opening File.
methodgetRefreshDate()
           Gets the date when the PivotTable was last refreshed.
methodgetRefreshedByWho()
           Gets the name of the user who last refreshed the PivotTable
methodgetRowFields()
           Returns a PivotFields object that are currently shown as row fields.
methodgetRowGrand()
methodsetRowGrand(value)
           Indicates whether the PivotTable report shows grand totals for rows.
methodgetRowHeaderCaption()
methodsetRowHeaderCaption(value)
           Gets the Row Header Caption of the PivotTable.
methodgetRowRange()
           Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
methodgetSaveData()
methodsetSaveData(value)
           Indicates whether data for the PivotTable report is saved with the workbook.
methodgetShowDataTips()
methodsetShowDataTips(value)
           Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
methodgetShowDrill()
methodsetShowDrill(value)
           Gets whether expand/collapse buttons is shown.
methodgetShowEmptyCol()
methodsetShowEmptyCol(value)
           Specifies a boolean value that indicates whether to include empty columns in the table
methodgetShowEmptyRow()
methodsetShowEmptyRow(value)
           Specifies a boolean value that indicates whether to include empty rows in the table.
methodgetShowMemberPropertyTips()
methodsetShowMemberPropertyTips(value)
           Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
methodgetShowPivotStyleColumnHeader()
methodsetShowPivotStyleColumnHeader(value)
           Indicates whether the column header in the pivot table should have the style applied.
methodgetShowPivotStyleColumnStripes()
methodsetShowPivotStyleColumnStripes(value)
           Indicates whether column stripe formatting is applied.
methodgetShowPivotStyleLastColumn()
methodsetShowPivotStyleLastColumn(value)
           Indicates whether column stripe formatting is applied.
methodgetShowPivotStyleRowHeader()
methodsetShowPivotStyleRowHeader(value)
           Indicates whether the row header in the pivot table should have the style applied.
methodgetShowPivotStyleRowStripes()
methodsetShowPivotStyleRowStripes(value)
           Indicates whether row stripe formatting is applied.
methodgetShowRowHeaderCaption()
methodsetShowRowHeaderCaption(value)
           Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
methodgetShowValuesRow()
methodsetShowValuesRow(value)
           Specifies a boolean value that indicates whether show values row. show the values row
methodgetSubtotalHiddenPageItems()
methodsetSubtotalHiddenPageItems(value)
           Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals. The default value is False.
methodgetTableRange1()
           Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only.
methodgetTableRange2()
           Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
methodgetTag()
methodsetTag(value)
           Gets a string saved with the PivotTable report.
 
Method Summary
methodaddCalculatedField(name, formula)
           Adds a calclulated field to pivot field and drag it to data area.
methodaddCalculatedField(name, formula, dragToDataArea)
           Adds a calclulated field to pivot field.
methodaddFieldToArea(fieldType, pivotField)
           Adds the field to the specific area.
methodaddFieldToArea(fieldType, baseFieldIndex)
           Adds the field to the specific area.
methodaddFieldToArea(fieldType, fieldName)
           Adds the field to the specific area.
methodcalculateData()
           Calculates pivottable's data to cells.
methodcalculateRange()
           Calculates pivottable's range.
methodchangeDataSource(source)
           Set pivottable's source data. Sheet1!$A$1:$C$3
methodclearData()
           Clear PivotTable's data and formatting
methodcopyStyle(pivotTable)
           Copies named style from another pivot table.
methodfields(fieldType)
           Gets the specific fields by the field type.
methodformat(row, column, style)
           Format the cell in the pivottable area
methodformatAll(style)
           Format all the cell in the pivottable area
methodgetCellByDisplayName(displayName)
           Gets the Cell object by the DisplayName of PivotField
methodgetChildren()
           Gets the the Children Pivot Tables which use this PivotTable data as data source.
methodgetHorizontalBreaks()
           get pivot table row index list of horizontal pagebreaks
methodgetSource()
           Get pivottable's source data.
methodmove(row, column)
           Moves the PivotTable to a different location in the worksheet.
methodmove(destCellName)
           Moves the PivotTable to a different location in the worksheet.
methodrefreshData()
           Refreshes pivottable's data and setting from it's data source.
methodremoveField(fieldType, pivotField)
           Remove field from specific field area
methodremoveField(fieldType, baseFieldIndex)
           Removes a field from specific field area
methodremoveField(fieldType, fieldName)
           Removes a field from specific field area
methodsetAutoGroupField(pivotField)
           Sets auto field group by the PivotTable.
methodsetAutoGroupField(baseFieldIndex)
           Sets auto field group by the PivotTable.
methodsetManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)
           Sets manual field group by the PivotTable.
methodsetManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)
           Sets manual field group by the PivotTable.
methodsetManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)
           Sets manual field group by the PivotTable.
methodsetManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)
           Sets manual field group by the PivotTable.
methodsetUngroup(pivotField)
           Sets ungroup by the PivotTable
methodsetUngroup(baseFieldIndex)
           Sets ungroup by the PivotTable
methodshowInCompactForm()
           Layouts the PivotTable in compact form.
methodshowInOutlineForm()
           Layouts the PivotTable in outline form.
methodshowInTabularForm()
           Layouts the PivotTable in tabular form.
methodshowReportFilterPage(pageField)
           Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
methodshowReportFilterPageByIndex(posIndex)
           Show all the report filter pages according to the position index in the PageFields
methodshowReportFilterPageByName(fieldName)
           Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields.
 

Property Getters/Setters Detail

isExcel2003Compatible/setExcel2003Compatible : boolean 

boolean isExcel2003Compatible() / setExcel2003Compatible(value)
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 : String 

String getRefreshedByWho()
Gets the name of the user who last refreshed the PivotTable

getRefreshDate : DateTime 

DateTime getRefreshDate()
Gets the date when the PivotTable was last refreshed.

getPivotTableStyleName/setPivotTableStyleName : String 

String getPivotTableStyleName() / setPivotTableStyleName(value)
Gets and sets the pivottable style name.

getPivotTableStyleType/setPivotTableStyleType : int 

int getPivotTableStyleType() / setPivotTableStyleType(value)
Gets and sets the built-in pivot table style. The value of the property is PivotTableStyleType integer constant.

getColumnFields : PivotFieldCollection 

PivotFieldCollection getColumnFields()
Returns a PivotFields object that are currently shown as column fields.

getRowFields : PivotFieldCollection 

PivotFieldCollection getRowFields()
Returns a PivotFields object that are currently shown as row fields.

getPageFields : PivotFieldCollection 

PivotFieldCollection getPageFields()
Returns a PivotFields object that are currently shown as page fields.

getDataFields : PivotFieldCollection 

PivotFieldCollection 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 : PivotField 

PivotField getDataField()
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.

getBaseFields : PivotFieldCollection 

PivotFieldCollection getBaseFields()
Returns a PivotFields object that includes all fields in the PivotTable report

getPivotFilters : PivotFilterCollection 

PivotFilterCollection getPivotFilters()
Returns a PivotFilterCollection object.

getColumnRange : CellArea 

CellArea getColumnRange()
Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.

getRowRange : CellArea 

CellArea getRowRange()
Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.

getDataBodyRange : CellArea 

CellArea getDataBodyRange()
Returns a CellArea object that represents the range that contains the data area in the list between the header row and the insert row. Read-only.

getTableRange1 : CellArea 

CellArea getTableRange1()
Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only.

getTableRange2 : CellArea 

CellArea getTableRange2()
Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.

getColumnGrand/setColumnGrand : boolean 

boolean getColumnGrand() / setColumnGrand(value)
Indicates whether the PivotTable report shows grand totals for columns.

isGridDropZones/setGridDropZones : boolean 

boolean isGridDropZones() / setGridDropZones(value)
Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)

getRowGrand/setRowGrand : boolean 

boolean getRowGrand() / setRowGrand(value)
Indicates whether the PivotTable report shows grand totals for rows.

getDisplayNullString/setDisplayNullString : boolean 

boolean getDisplayNullString() / setDisplayNullString(value)
Indicates whether the PivotTable report displays a custom string in cells that contain null values.

getNullString/setNullString : String 

String getNullString() / setNullString(value)
Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.

getDisplayErrorString/setDisplayErrorString : boolean 

boolean getDisplayErrorString() / setDisplayErrorString(value)
Indicates whether the PivotTable report displays a custom string in cells that contain errors.

getErrorString/setErrorString : String 

String getErrorString() / setErrorString(value)
Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.

isAutoFormat/setAutoFormat : boolean 

boolean isAutoFormat() / setAutoFormat(value)
Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table "which in pivottable option for Excel 2003 Checkbox "autofit column width on update"which in pivot table Options :Layout Format for Excel 2007

getAutoFormatType/setAutoFormatType : int 

int getAutoFormatType() / setAutoFormatType(value)
Gets the PivotTable auto format type. The value of the property is PivotTableAutoFormatType integer constant.PivotTableAutoFormatType

hasBlankRows/setHasBlankRows : boolean 

boolean hasBlankRows() / setHasBlankRows(value)
Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.

getMergeLabels/setMergeLabels : boolean 

boolean getMergeLabels() / setMergeLabels(value)
Indicates whether the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.

getPreserveFormatting/setPreserveFormatting : boolean 

boolean getPreserveFormatting() / setPreserveFormatting(value)
Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.

getShowDrill/setShowDrill : boolean 

boolean getShowDrill() / setShowDrill(value)
Gets whether expand/collapse buttons is shown.

getEnableDrilldown/setEnableDrilldown : boolean 

boolean getEnableDrilldown() / setEnableDrilldown(value)
Gets whether drilldown is enabled.

getEnableFieldDialog/setEnableFieldDialog : boolean 

boolean getEnableFieldDialog() / setEnableFieldDialog(value)
Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.

getEnableFieldList/setEnableFieldList : boolean 

boolean getEnableFieldList() / setEnableFieldList(value)
Gets whether enable the field list for the PivotTable.

getEnableWizard/setEnableWizard : boolean 

boolean getEnableWizard() / setEnableWizard(value)
Indicates whether the PivotTable Wizard is available.

getSubtotalHiddenPageItems/setSubtotalHiddenPageItems : boolean 

boolean getSubtotalHiddenPageItems() / setSubtotalHiddenPageItems(value)
Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals. The default value is False.

getGrandTotalName/setGrandTotalName : String 

String getGrandTotalName() / setGrandTotalName(value)
Returns the text string label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".

getManualUpdate/setManualUpdate : boolean 

boolean getManualUpdate() / setManualUpdate(value)
Indicates whether the PivotTable report is recalculated only at the user's request.

isMultipleFieldFilters/setMultipleFieldFilters : boolean 

boolean isMultipleFieldFilters() / setMultipleFieldFilters(value)
Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.

getMissingItemsLimit/setMissingItemsLimit : int 

int getMissingItemsLimit() / setMissingItemsLimit(value)
Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. The value of the property is PivotMissingItemLimitType integer constant.

getEnableDataValueEditing/setEnableDataValueEditing : boolean 

boolean getEnableDataValueEditing() / setEnableDataValueEditing(value)
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/setShowDataTips : boolean 

boolean getShowDataTips() / setShowDataTips(value)
Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.

getShowMemberPropertyTips/setShowMemberPropertyTips : boolean 

boolean getShowMemberPropertyTips() / setShowMemberPropertyTips(value)
Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.

getShowValuesRow/setShowValuesRow : boolean 

boolean getShowValuesRow() / setShowValuesRow(value)
Specifies a boolean value that indicates whether show values row. show the values row

getShowEmptyCol/setShowEmptyCol : boolean 

boolean getShowEmptyCol() / setShowEmptyCol(value)
Specifies a boolean value that indicates whether to include empty columns in the table

getShowEmptyRow/setShowEmptyRow : boolean 

boolean getShowEmptyRow() / setShowEmptyRow(value)
Specifies a boolean value that indicates whether to include empty rows in the table.

getFieldListSortAscending/setFieldListSortAscending : boolean 

boolean getFieldListSortAscending() / setFieldListSortAscending(value)
Specifies a boolean value that indicates whether fields in the PivotTable are sorted in non-default order in the field list.

getPrintDrill/setPrintDrill : boolean 

boolean getPrintDrill() / setPrintDrill(value)
Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.

getAltTextTitle/setAltTextTitle : String 

String getAltTextTitle() / setAltTextTitle(value)
Gets the title of the alttext

getAltTextDescription/setAltTextDescription : String 

String getAltTextDescription() / setAltTextDescription(value)
Gets the description of the alt text

getName/setName : String 

String getName() / setName(value)
Gets the name of the PivotTable

getColumnHeaderCaption/setColumnHeaderCaption : String 

String getColumnHeaderCaption() / setColumnHeaderCaption(value)
Gets the Column Header Caption of the PivotTable.

getIndent/setIndent : int 

int getIndent() / setIndent(value)
Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.

getRowHeaderCaption/setRowHeaderCaption : String 

String getRowHeaderCaption() / setRowHeaderCaption(value)
Gets the Row Header Caption of the PivotTable.

getShowRowHeaderCaption/setShowRowHeaderCaption : boolean 

boolean getShowRowHeaderCaption() / setShowRowHeaderCaption(value)
Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs

getCustomListSort/setCustomListSort : boolean 

boolean getCustomListSort() / setCustomListSort(value)
Indicates whether consider built-in custom list when sort data

getPivotFormatConditions : PivotFormatConditionCollection 

PivotFormatConditionCollection getPivotFormatConditions()
Gets the Format Conditions of the pivot table.

getPageFieldOrder/setPageFieldOrder : int 

int getPageFieldOrder() / setPageFieldOrder(value)
Gets the order in which page fields are added to the PivotTable report's layout. The value of the property is PrintOrderType integer constant.

getPageFieldWrapCount/setPageFieldWrapCount : int 

int getPageFieldWrapCount() / setPageFieldWrapCount(value)
Gets the number of page fields in each column or row in the PivotTable report.

getTag/setTag : String 

String getTag() / setTag(value)
Gets a string saved with the PivotTable report.

getSaveData/setSaveData : boolean 

boolean getSaveData() / setSaveData(value)
Indicates whether data for the PivotTable report is saved with the workbook.

getRefreshDataOnOpeningFile/setRefreshDataOnOpeningFile : boolean 

boolean getRefreshDataOnOpeningFile() / setRefreshDataOnOpeningFile(value)
Indicates whether Refresh Data when Opening File.

getRefreshDataFlag/setRefreshDataFlag : boolean 

boolean getRefreshDataFlag() / setRefreshDataFlag(value)
Indicates whether Refresh Data or not.

getDataSource/setDataSource : String[] 

String[] getDataSource() / setDataSource(value)
Gets and sets the data source of the pivot table.

getItemPrintTitles/setItemPrintTitles : boolean 

boolean getItemPrintTitles() / setItemPrintTitles(value)
A bit that specifies whether pivot item captions on the row axis are repeated on each printed page for pivot fields in tabular form.

getPrintTitles/setPrintTitles : boolean 

boolean getPrintTitles() / setPrintTitles(value)
Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.

getDisplayImmediateItems/setDisplayImmediateItems : boolean 

boolean getDisplayImmediateItems() / setDisplayImmediateItems(value)
Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty. The default value is true.

isSelected/setSelected : boolean 

boolean isSelected() / setSelected(value)
Indicates whether the PivotTable is selected.

getShowPivotStyleRowHeader/setShowPivotStyleRowHeader : boolean 

boolean getShowPivotStyleRowHeader() / setShowPivotStyleRowHeader(value)
Indicates whether the row header in the pivot table should have the style applied.

getShowPivotStyleColumnHeader/setShowPivotStyleColumnHeader : boolean 

boolean getShowPivotStyleColumnHeader() / setShowPivotStyleColumnHeader(value)
Indicates whether the column header in the pivot table should have the style applied.

getShowPivotStyleRowStripes/setShowPivotStyleRowStripes : boolean 

boolean getShowPivotStyleRowStripes() / setShowPivotStyleRowStripes(value)
Indicates whether row stripe formatting is applied.

getShowPivotStyleColumnStripes/setShowPivotStyleColumnStripes : boolean 

boolean getShowPivotStyleColumnStripes() / setShowPivotStyleColumnStripes(value)
Indicates whether column stripe formatting is applied.

getShowPivotStyleLastColumn/setShowPivotStyleLastColumn : boolean 

boolean getShowPivotStyleLastColumn() / setShowPivotStyleLastColumn(value)
Indicates whether column stripe formatting is applied.

Method Detail

changeDataSource

 changeDataSource(source)
Set pivottable's source data. Sheet1!$A$1:$C$3

getSource

String[] getSource()
Get pivottable's source data.

refreshData

 refreshData()
Refreshes pivottable's data and setting from it's data source. We will gather data from data source to a pivot cache ,then calcualte the data in the cache to the cells. This method is only used to gather all data to a pivot cache.

calculateData

 calculateData()
Calculates pivottable's data to cells. Cell.Value in the pivot range could not return the correct result if the method is not been called. This method caclulates data with an inner pivot cache,not original data source. So if the data source is changed, please call RefreshData() method first.

clearData

 clearData()
Clear PivotTable's data and formatting If this method is not callled before you add or delete PivotField, Maybe the PivotTable data is not corrected

calculateRange

 calculateRange()
Calculates pivottable's range. If this method is not been called,maybe the pivottable range is not corrected.

formatAll

 formatAll(style)
Format all the cell in the pivottable area
Parameters:
style: Style - Style which is to format

format

 format(row, column, style)
Format the cell in the pivottable area
Parameters:
row: int - RowIndex of the cell
column: int - Column index of the cell
style: Style - Style which is to format the cell

setAutoGroupField

 setAutoGroupField(baseFieldIndex)
Sets auto field group by the PivotTable.
Parameters:
baseFieldIndex: int - The row or column field index in the base fields

setAutoGroupField

 setAutoGroupField(pivotField)
Sets auto field group by the PivotTable.
Parameters:
pivotField: PivotField - The row or column field in the specific fields

setManualGroupField

 setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)
Sets manual field group by the PivotTable.
Parameters:
baseFieldIndex: int - The row or column field index in the base fields
startVal: float - Specifies the starting value for numeric grouping.
endVal: float - Specifies the ending value for numeric grouping.
groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType
intervalNum: float - Specifies the interval number group by numeric grouping.

setManualGroupField

 setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)
Sets manual field group by the PivotTable.
Parameters:
pivotField: PivotField - The row or column field in the base fields
startVal: float - Specifies the starting value for numeric grouping.
endVal: float - Specifies the ending value for numeric grouping.
groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType
intervalNum: float - Specifies the interval number group by numeric grouping.

setManualGroupField

 setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)
Sets manual field group by the PivotTable.
Parameters:
baseFieldIndex: int - The row or column field index in the base fields
startVal: DateTime - Specifies the starting value for date grouping.
endVal: DateTime - Specifies the ending value for date grouping.
groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType
intervalNum: int - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero

setManualGroupField

 setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)
Sets manual field group by the PivotTable.
Parameters:
pivotField: PivotField - The row or column field in the base fields
startVal: DateTime - Specifies the starting value for date grouping.
endVal: DateTime - Specifies the ending value for date grouping.
groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType
intervalNum: int - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero

setUngroup

 setUngroup(baseFieldIndex)
Sets ungroup by the PivotTable
Parameters:
baseFieldIndex: int - The row or column field index in the base fields

setUngroup

 setUngroup(pivotField)
Sets ungroup by the PivotTable
Parameters:
pivotField: PivotField - The row or column field in the base fields

getHorizontalBreaks

ArrayList getHorizontalBreaks()
get pivot table row index list of horizontal pagebreaks
Returns:

showInCompactForm

 showInCompactForm()
Layouts the PivotTable in compact form.

showInOutlineForm

 showInOutlineForm()
Layouts the PivotTable in outline form.

showInTabularForm

 showInTabularForm()
Layouts the PivotTable in tabular form.

getCellByDisplayName

Cell getCellByDisplayName(displayName)
Gets the Cell object by the DisplayName of PivotField
Parameters:
displayName: String - the DisplayName of PivotField
Returns:
the Cell object

getChildren

PivotTable[] getChildren()
Gets the the Children Pivot Tables which use this PivotTable data as data source.
Returns:
the PivotTable array object

copyStyle

 copyStyle(pivotTable)
Copies named style from another pivot table.
Parameters:
pivotTable: PivotTable - Source pivot table.

showReportFilterPage

 showReportFilterPage(pageField)
Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
Parameters:
pageField: PivotField - The PivotField object

showReportFilterPageByName

 showReportFilterPageByName(fieldName)
Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields.
Parameters:
fieldName: String - The name of PivotField

showReportFilterPageByIndex

 showReportFilterPageByIndex(posIndex)
Show all the report filter pages according to the position index in the PageFields
Parameters:
posIndex: int - The position index in the PageFields

removeField

 removeField(fieldType, fieldName)
Removes a field from specific field area removeField(int, com.aspose.cells.PivotField)
Parameters:
fieldType: int - A PivotFieldType value. The fields area type.
fieldName: String - The name in the base fields.

removeField

 removeField(fieldType, baseFieldIndex)
Removes a field from specific field area removeField(int, com.aspose.cells.PivotField)
Parameters:
fieldType: int - A PivotFieldType value. The fields area type.
baseFieldIndex: int - The field index in the base fields.

removeField

 removeField(fieldType, pivotField)
Remove field from specific field area
Parameters:
fieldType: int - A PivotFieldType value. the fields area type.It could be one of the following values:
PivotFieldType.Row
PivotFieldType.Column
PivotFieldType.Data
PivotFieldType.Page
pivotField: PivotField - the field in the base fields.

addFieldToArea

int addFieldToArea(fieldType, fieldName)
Adds the field to the specific area. addFieldToArea(int, com.aspose.cells.PivotField)
Parameters:
fieldType: int - A PivotFieldType value. The fields area type.
fieldName: String - The name in the base fields.
Returns:
The field position in the specific fields.If there is no field named as it, return -1.

addFieldToArea

int addFieldToArea(fieldType, baseFieldIndex)
Adds the field to the specific area. addFieldToArea(int, com.aspose.cells.PivotField)
Parameters:
fieldType: int - A PivotFieldType value. The fields area type.
baseFieldIndex: int - The field index in the base fields.
Returns:
The field position in the specific fields.

addFieldToArea

int addFieldToArea(fieldType, pivotField)
Adds the field to the specific area.
Parameters:
fieldType: int - A PivotFieldType value. the fields area type.It could be one of the following values:
PivotFieldType.Row
PivotFieldType.Column
PivotFieldType.Data
PivotFieldType.Page
pivotField: PivotField - the field in the base fields.
Returns:
the field position in the specific fields.

addCalculatedField

 addCalculatedField(name, formula, dragToDataArea)
Adds a calclulated field to pivot field.
Parameters:
name: String - The name of the calculated field
formula: String - The formula of the calculated field.
dragToDataArea: boolean - True,drag this field to data area immediately

addCalculatedField

 addCalculatedField(name, formula)
Adds a calclulated field to pivot field and drag it to data area.
Parameters:
name: String - The name of the calculated field
formula: String - The formula of the calculated field.

fields

PivotFieldCollection fields(fieldType)
Gets the specific fields by the field type.
Parameters:
fieldType: int - A PivotFieldType value. the field type.
Returns:
the specific fields

move

 move(row, column)
Moves the PivotTable to a different location in the worksheet.
Parameters:
row: int - row index.
column: int - column index.

move

 move(destCellName)
Moves the PivotTable to a different location in the worksheet.
Parameters:
destCellName: String - the dest cell name.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.