com.spire.xls.core
Interface IPivotTableOptions

public interface IPivotTableOptions

Describes the settings of the pivot table

Method Summary

java.lang.String	getColumnHeaderCaption() Specifies the string to be displayed in column header of pivot Table when in compact layout mode.
short	getDataPosition() Specifies the position for the field representing multiple data field in the PivotTable, whether that field is located in the row area or column area.
boolean	getEnableFieldProperties() True if the PivotTable Field dialog box is available when the user double-clicks the PivotTable field
long	getIndent() Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
java.lang.String	getRowHeaderCaption() Specifies the string to be displayed in Row header of pivot table when in compact layout mode
boolean	getShowAsteriskTotals() True if an asterisk (*) is displayed next to each subtotal and grand total value in the specified PivotTable report
boolean	getShowCustomSortList() Specifies a boolean value that indicates whether the "custom lists" option is offered when sorting this PivotTable
boolean	getShowFieldList() False to disable the ability to display the field list for the PivotTable.
boolean	getShowGridDropZone() Specifies a boolean value that indicates whether the in-grid drop zones should be displayed at runtime, and whether classic layout is applied.
boolean	isAutoFormat() Indicates whether the PivotTable has an autoformat applied.
void	isAutoFormat(boolean value) Indicates whether the PivotTable has an autoformat applied.
boolean	isDataEditable() True to disable the alert for when the user overwrites values in the data area of the PivotTable.
void	isDataEditable(boolean dataEditable) True to disable the alert for when the user overwrites values in the data area of the PivotTable.
void	setColumnHeaderCaption(java.lang.String columnHeaderCaption) Specifies the string to be displayed in column header of pivot Table when in compact layout mode.
void	setDataPosition(short value) Specifies the position for the field representing multiple data field in the PivotTable, whether that field is located in the row area or column area.
void	setEnableFieldProperties(boolean enableFieldProperties) True if the PivotTable Field dialog box is available when the user double-clicks the PivotTable field
void	setIndent(long indent) Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
void	setRowHeaderCaption(java.lang.String rowHeaderCaption) Specifies the string to be displayed in Row header of pivot table when in compact layout mode
void	setShowAsteriskTotals(boolean showAsteriskTotals) True if an asterisk (*) is displayed next to each subtotal and grand total value in the specified PivotTable report
void	setShowCustomSortList(boolean showCustomSortList) Specifies a boolean value that indicates whether the "custom lists" option is offered when sorting this PivotTable
void	setShowFieldList(boolean showFieldList) False to disable the ability to display the field list for the PivotTable.
void	setShowGridDropZone(boolean value) Specifies a boolean value that indicates whether the in-grid drop zones should be displayed at runtime, and whether classic layout is applied.

Method Detail

getShowAsteriskTotals

boolean getShowAsteriskTotals()

True if an asterisk (*) is displayed next to each subtotal and grand total value in the specified PivotTable report

Returns:

setShowAsteriskTotals

void setShowAsteriskTotals(boolean showAsteriskTotals)

True if an asterisk (*) is displayed next to each subtotal and grand total value in the specified PivotTable report

Parameters:

showAsteriskTotals -

getColumnHeaderCaption

java.lang.String getColumnHeaderCaption()

Specifies the string to be displayed in column header of pivot Table when in compact layout mode.

Returns:

setColumnHeaderCaption

void setColumnHeaderCaption(java.lang.String columnHeaderCaption)

Specifies the string to be displayed in column header of pivot Table when in compact layout mode.

Parameters:

columnHeaderCaption -

getRowHeaderCaption

java.lang.String getRowHeaderCaption()

Specifies the string to be displayed in Row header of pivot table when in compact layout mode

Returns:

setRowHeaderCaption

void setRowHeaderCaption(java.lang.String rowHeaderCaption)

Specifies the string to be displayed in Row header of pivot table when in compact layout mode

Parameters:

rowHeaderCaption -

getShowCustomSortList

boolean getShowCustomSortList()

Specifies a boolean value that indicates whether the "custom lists" option is offered when sorting this PivotTable

Returns:

setShowCustomSortList

void setShowCustomSortList(boolean showCustomSortList)

Specifies a boolean value that indicates whether the "custom lists" option is offered when sorting this PivotTable

Parameters:

showCustomSortList -

getShowFieldList

boolean getShowFieldList()

False to disable the ability to display the field list for the PivotTable. If the field list was already being displayed it disappears.

Returns:

setShowFieldList

void setShowFieldList(boolean showFieldList)

False to disable the ability to display the field list for the PivotTable. If the field list was already being displayed it disappears.

Parameters:

showFieldList -

getShowGridDropZone

boolean getShowGridDropZone()

Specifies a boolean value that indicates whether the in-grid drop zones should be displayed at runtime, and whether classic layout is applied.

Returns:

setShowGridDropZone

void setShowGridDropZone(boolean value)

Specifies a boolean value that indicates whether the in-grid drop zones should be displayed at runtime, and whether classic layout is applied.

Parameters:

value -

isDataEditable

boolean isDataEditable()

True to disable the alert for when the user overwrites values in the data area of the PivotTable. True also allows the user to change data values that previously could not be changed

Returns:

isDataEditable

void isDataEditable(boolean dataEditable)

True to disable the alert for when the user overwrites values in the data area of the PivotTable. True also allows the user to change data values that previously could not be changed

Parameters:

dataEditable -

getEnableFieldProperties

boolean getEnableFieldProperties()

True if the PivotTable Field dialog box is available when the user double-clicks the PivotTable field

Returns:

setEnableFieldProperties

void setEnableFieldProperties(boolean enableFieldProperties)

True if the PivotTable Field dialog box is available when the user double-clicks the PivotTable field

Parameters:

enableFieldProperties -

getIndent

long getIndent()

Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.

Returns:

setIndent

void setIndent(long indent)

Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.

Parameters:

indent -

isAutoFormat

boolean isAutoFormat()

Indicates whether the PivotTable has an autoformat applied. Checkbox "autofit column width on update"which in pivot table Options :Layout Format for Excel 2007

Returns:

isAutoFormat

void isAutoFormat(boolean value)

Indicates whether the PivotTable has an autoformat applied. Checkbox "autofit column width on update"which in pivot table Options :Layout Format for Excel 2007

Parameters:

value -

getDataPosition

short getDataPosition()

Specifies the position for the field representing multiple data field in the PivotTable, whether that field is located in the row area or column area. value start with 0 , -1 means the last position

Returns:

setDataPosition

void setDataPosition(short value)

Specifies the position for the field representing multiple data field in the PivotTable, whether that field is located in the row area or column area. value start with 0 , -1 means the last position

Parameters:

value -