IPivotField

```
public interface IPivotField
```
Represents a field in a PivotTable report. The PivotField object is a member of the PivotFields collection. The PivotFields collection contains all the fields in a PivotTable report, including hidden fields.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`autoSort(SortOrder Order)` Establishes automatic field-sorting rules for PivotTable reports.
`void`	`autoSort(SortOrder Order, java.lang.String Field)` Establishes automatic field-sorting rules for PivotTable reports.
`void`	`clearAllFilters()` Deletes all filters currently applied to the PivotField.
`void`	`clearManualFilter()` Provides an easy way to set the Visible property to True for all items of a PivotField in PivotTables, and to empty the HiddenItemsList and VisibleItemsList collections in OLAP PivotTables.
`boolean`	`getAllItemsVisible()` Retrieves a value that indicates whether any manual filtering is applied to Pivotfield.
`java.lang.String`	`getAutoSortField()` Returns the name of the data field used to sort the specified PivotTable field automatically.
`SortOrder`	`getAutoSortOrder()` Returns the order used to sort the specified PivotTable field automatically.
`java.lang.String`	`getBaseField()` Gets the base field for a custom calculation.
`java.lang.String`	`getBaseItem()` Gets the item in the base field for a custom calculation.
`ICalculatedItems`	`getCalculatedItems()` Returns a `ICalculatedItems` collection that represents all the calculated items in the specified PivotTable report.
`PivotFieldCalculation`	`getCalculation()` Gets a value that represents the type of calculation performed by the specified field.
`int`	`getCurrentPage()` Gets the current page's index showing for the page field (valid only for page fields).
`boolean`	`getDragToColumn()` Gets whether the specified field can be dragged to the column position.
`boolean`	`getDragToData()` Gets whether the specified field can be dragged to the data position.
`boolean`	`getDragToHide()` Gets whether the field can be hidden by being dragged off the PivotTable report.
`boolean`	`getDragToPage()` Gets whether the field can be dragged to the page position.
`boolean`	`getDragToRow()` Gets whether the field can be dragged to the row position.
`boolean`	`getEnableMultiplePageItems()` Gets whether the field can have multiple items selected in the page field.
`java.lang.String`	`getFormula()` Gets a String value that represents the object's formula in A1-style notation and in the language of the macro.
`ConsolidationFunction`	`getFunction()` Gets the function used to summarize the PivotTable field (data fields only).
`boolean`	`getLayoutBlankLine()` Gets if a blank row is inserted after the specified row field in a PivotTable report.
`boolean`	`getLayoutCompactRow()` Gets whether or not a PivotField is compacted(items of multiple PivotFields are displayed in a single column) when rows are selected.
`LayoutFormType`	`getLayoutForm()` Returns the way the specified PivotTable items appear — in table format or in outline format.
`SubtotalLocationType`	`getLayoutSubtotalLocation()` Gets the position of the PivotTable field subtotals in relation to (either above or below) the specified field.
`java.lang.String`	`getName()` Gets the name of the object.
`java.lang.String`	`getNumberFormat()` Gets the format code for the object.
`PivotFieldOrientation`	`getOrientation()` Gets the location of the field in the specified PivotTable report.
`IPivotItems`	`getPivotItems()` Returns a collection of all the visible and hidden items in the specified field.
`int`	`getPosition()` Gets the position of the field (first, second, third, and so on) among all the fields in its orientation (Rows, Columns, Pages, Data).
`boolean`	`getRepeatLabels()` Gets whether item labels are repeated in the PivotTable for the specified PivotField.
`boolean`	`getShowAllItems()` Gets if all items in the PivotTable report are displayed, even if they don’t contain summary data.
`java.lang.String`	`getSourceName()` Returns the specified object’s name as it appears in the original source data for the specified PivotTable report.
`java.util.EnumSet<SubtotalType>`	`getSubtotals()` Gets a combination of all the showing subtotal types in the specified PivotField.
`void`	`setBaseField(java.lang.String value)` Sets the base field for a custom calculation.
`void`	`setBaseItem(java.lang.String value)` Sets the item in the base field for a custom calculation.
`void`	`setCalculation(PivotFieldCalculation value)` Sets a value that represents the type of calculation performed by the specified field.
`void`	`setCurrentPage(int value)` Sets the current page's index showing for the page field (valid only for page fields).
`void`	`setDragToColumn(boolean value)` Sets whether the specified field can be dragged to the column position.
`void`	`setDragToData(boolean value)` Sets whether the specified field can be dragged to the data position.
`void`	`setDragToHide(boolean value)` Sets whether the field can be hidden by being dragged off the PivotTable report.
`void`	`setDragToPage(boolean value)` Sets whether the field can be dragged to the page position.
`void`	`setDragToRow(boolean value)` Sets whether the field can be dragged to the row position.
`void`	`setEnableMultiplePageItems(boolean value)` Sets whether the field can have multiple items selected in the page field.
`void`	`setFormula(java.lang.String value)` Sets a String value that represents the object's formula in A1-style notation and in the language of the macro.
`void`	`setFunction(ConsolidationFunction value)` Sets the function used to summarize the PivotTable field (data fields only).
`void`	`setLayoutBlankLine(boolean value)` Sets if a blank row is inserted after the specified row field in a PivotTable report.
`void`	`setLayoutCompactRow(boolean value)` Sets whether or not a PivotField is compacted(items of multiple PivotFields are displayed in a single column) when rows are selected.
`void`	`setLayoutForm(LayoutFormType value)` Sets the way the specified PivotTable items appear — in table format or in outline format.
`void`	`setLayoutSubtotalLocation(SubtotalLocationType value)` Sets the position of the PivotTable field subtotals in relation to (either above or below) the specified field.
`void`	`setName(java.lang.String value)` Sets the name of the object.
`void`	`setNumberFormat(java.lang.String value)` Sets the format code for the object.
`void`	`setOrientation(PivotFieldOrientation value)` Sets the location of the field in the specified PivotTable report.
`void`	`setPosition(int value)` Sets the position of the field (first, second, third, and so on) among all the fields in its orientation (Rows, Columns, Pages, Data).
`void`	`setRepeatLabels(boolean value)` Sets whether item labels are repeated in the PivotTable for the specified PivotField.
`void`	`setShowAllItems(boolean value)` Sets if all items in the PivotTable report are displayed, even if they don’t contain summary data.
`void`	`setSubtotals(java.util.EnumSet<SubtotalType> value)` Sets a combination of all the showing subtotal types in the specified PivotField.

- Method Detail
  - getAllItemsVisible
```
boolean getAllItemsVisible()
```
    Retrieves a value that indicates whether any manual filtering is applied to Pivotfield.
  - getAutoSortField
```
java.lang.String getAutoSortField()
```
    Returns the name of the data field used to sort the specified PivotTable field automatically.
  - getAutoSortOrder
```
SortOrder getAutoSortOrder()
```
    Returns the order used to sort the specified PivotTable field automatically.
  - getBaseField
```
java.lang.String getBaseField()
```
    Gets the base field for a custom calculation. This property is valid only for data fields.
  - setBaseField
```
void setBaseField(java.lang.String value)
```
    Sets the base field for a custom calculation. This property is valid only for data fields.
  - getBaseItem
```
java.lang.String getBaseItem()
```
    Gets the item in the base field for a custom calculation. Valid only for data fields.
  - setBaseItem
```
void setBaseItem(java.lang.String value)
```
    Sets the item in the base field for a custom calculation. Valid only for data fields.
  - getCalculation
```
PivotFieldCalculation getCalculation()
```
    Gets a value that represents the type of calculation performed by the specified field. This property is valid only for data fields.
  - setCalculation
```
void setCalculation(PivotFieldCalculation value)
```
    Sets a value that represents the type of calculation performed by the specified field. This property is valid only for data fields.
  - getCurrentPage
```
int getCurrentPage()
```
    Gets the current page's index showing for the page field (valid only for page fields). The valid value is based on zero. "-1" indicates "All" or "Multiple Items".
  - setCurrentPage
```
void setCurrentPage(int value)
```
    Sets the current page's index showing for the page field (valid only for page fields). The valid value is based on zero. "-1" indicates "All" or "Multiple Items".
  - getDragToColumn
```
boolean getDragToColumn()
```
    Gets whether the specified field can be dragged to the column position. The default value is True.
  - setDragToColumn
```
void setDragToColumn(boolean value)
```
    Sets whether the specified field can be dragged to the column position. The default value is True.
  - getDragToData
```
boolean getDragToData()
```
    Gets whether the specified field can be dragged to the data position. The default value is True.
  - setDragToData
```
void setDragToData(boolean value)
```
    Sets whether the specified field can be dragged to the data position. The default value is True.
  - getDragToHide
```
boolean getDragToHide()
```
    Gets whether the field can be hidden by being dragged off the PivotTable report. The default value is True.
  - setDragToHide
```
void setDragToHide(boolean value)
```
    Sets whether the field can be hidden by being dragged off the PivotTable report. The default value is True.
  - getDragToPage
```
boolean getDragToPage()
```
    Gets whether the field can be dragged to the page position. The default value is True.
  - setDragToPage
```
void setDragToPage(boolean value)
```
    Sets whether the field can be dragged to the page position. The default value is True.
  - getDragToRow
```
boolean getDragToRow()
```
    Gets whether the field can be dragged to the row position. The default value is True.
  - setDragToRow
```
void setDragToRow(boolean value)
```
    Sets whether the field can be dragged to the row position. The default value is True.
  - getEnableMultiplePageItems
```
boolean getEnableMultiplePageItems()
```
    Gets whether the field can have multiple items selected in the page field. The default value is false.
  - setEnableMultiplePageItems
```
void setEnableMultiplePageItems(boolean value)
```
    Sets whether the field can have multiple items selected in the page field. The default value is false.
  - getFormula
```
java.lang.String getFormula()
```
    Gets a String value that represents the object's formula in A1-style notation and in the language of the macro.
  - setFormula
```
void setFormula(java.lang.String value)
```
    Sets a String value that represents the object's formula in A1-style notation and in the language of the macro.
  - getFunction
```
ConsolidationFunction getFunction()
```
    Gets the function used to summarize the PivotTable field (data fields only).
  - setFunction
```
void setFunction(ConsolidationFunction value)
```
    Sets the function used to summarize the PivotTable field (data fields only).
  - getLayoutBlankLine
```
boolean getLayoutBlankLine()
```
    Gets if a blank row is inserted after the specified row field in a PivotTable report. The default value is False.
  - setLayoutBlankLine
```
void setLayoutBlankLine(boolean value)
```
    Sets if a blank row is inserted after the specified row field in a PivotTable report. The default value is False.
  - getLayoutCompactRow
```
boolean getLayoutCompactRow()
```
    Gets whether or not a PivotField is compacted(items of multiple PivotFields are displayed in a single column) when rows are selected.
  - setLayoutCompactRow
```
void setLayoutCompactRow(boolean value)
```
    Sets whether or not a PivotField is compacted(items of multiple PivotFields are displayed in a single column) when rows are selected.
  - getLayoutForm
```
LayoutFormType getLayoutForm()
```
    Returns the way the specified PivotTable items appear — in table format or in outline format.
  - setLayoutForm
```
void setLayoutForm(LayoutFormType value)
```
    Sets the way the specified PivotTable items appear — in table format or in outline format.
  - getLayoutSubtotalLocation
```
SubtotalLocationType getLayoutSubtotalLocation()
```
    Gets the position of the PivotTable field subtotals in relation to (either above or below) the specified field.
  - setLayoutSubtotalLocation
```
void setLayoutSubtotalLocation(SubtotalLocationType value)
```
    Sets the position of the PivotTable field subtotals in relation to (either above or below) the specified field.
  - getName
```
java.lang.String getName()
```
    Gets the name of the object.
  - setName
```
void setName(java.lang.String value)
```
    Sets the name of the object.
  - getNumberFormat
```
java.lang.String getNumberFormat()
```
    Gets the format code for the object.
  - setNumberFormat
```
void setNumberFormat(java.lang.String value)
```
    Sets the format code for the object.
  - getOrientation
```
PivotFieldOrientation getOrientation()
```
    Gets the location of the field in the specified PivotTable report.
  - setOrientation
```
void setOrientation(PivotFieldOrientation value)
```
    Sets the location of the field in the specified PivotTable report.
  - getPosition
```
int getPosition()
```
    Gets the position of the field (first, second, third, and so on) among all the fields in its orientation (Rows, Columns, Pages, Data).
  - setPosition
```
void setPosition(int value)
```
    Sets the position of the field (first, second, third, and so on) among all the fields in its orientation (Rows, Columns, Pages, Data).
  - getRepeatLabels
```
boolean getRepeatLabels()
```
    Gets whether item labels are repeated in the PivotTable for the specified PivotField.
    
    Returns:
  - setRepeatLabels
```
void setRepeatLabels(boolean value)
```
    Sets whether item labels are repeated in the PivotTable for the specified PivotField.
  - getShowAllItems
```
boolean getShowAllItems()
```
    Gets if all items in the PivotTable report are displayed, even if they don’t contain summary data. The default value is False.
  - setShowAllItems
```
void setShowAllItems(boolean value)
```
    Sets if all items in the PivotTable report are displayed, even if they don’t contain summary data. The default value is False.
  - getSourceName
```
java.lang.String getSourceName()
```
    Returns the specified object’s name as it appears in the original source data for the specified PivotTable report. This might be different from the current item name if the user renamed the item after creating the PivotTable report.
  - getSubtotals
```
java.util.EnumSet<SubtotalType> getSubtotals()
```
    Gets a combination of all the showing subtotal types in the specified PivotField. Valid only for nondata fields.
  - setSubtotals
```
void setSubtotals(java.util.EnumSet<SubtotalType> value)
```
    Sets a combination of all the showing subtotal types in the specified PivotField. Valid only for nondata fields.
  - autoSort
```
void autoSort(SortOrder Order,
              java.lang.String Field)
```
    Establishes automatic field-sorting rules for PivotTable reports.
    
    Parameters:
    
    Order - Required SortOrder. The sort order.
    
    Field - The name of the sort key field. You must specify the unique name (as returned from the IPivotField.getSourceName()) and not the displayed name.
  - autoSort
```
void autoSort(SortOrder Order)
```
    Establishes automatic field-sorting rules for PivotTable reports.
    
    Parameters:
    
    Order - Required SortOrder. The sort order.
  - clearAllFilters
```
void clearAllFilters()
```
    Deletes all filters currently applied to the PivotField. This includes deleting all filters from the PivotFilters collection of the PivotField and removing any manual filtering applied to the PivotField as well. If the PivotField is in the Report Filter area, the item selected will be set to the default item.
  - clearManualFilter
```
void clearManualFilter()
```
    Provides an easy way to set the Visible property to True for all items of a PivotField in PivotTables, and to empty the HiddenItemsList and VisibleItemsList collections in OLAP PivotTables.
  - getPivotItems
```
IPivotItems getPivotItems()
```
    Returns a collection of all the visible and hidden items in the specified field.
  - getCalculatedItems
```
ICalculatedItems getCalculatedItems()
```
    Returns a ICalculatedItems collection that represents all the calculated items in the specified PivotTable report.
    
    Returns:
    
    CalculatedItems collection

Interface IPivotField

Method Summary

Method Detail

getAllItemsVisible

getAutoSortField

getAutoSortOrder

getBaseField

setBaseField

getBaseItem

setBaseItem

getCalculation

setCalculation

getCurrentPage

setCurrentPage

getDragToColumn

setDragToColumn

getDragToData

setDragToData

getDragToHide

setDragToHide

getDragToPage

setDragToPage

getDragToRow

setDragToRow

getEnableMultiplePageItems

setEnableMultiplePageItems

getFormula

setFormula

getFunction

setFunction

getLayoutBlankLine

setLayoutBlankLine

getLayoutCompactRow

setLayoutCompactRow

getLayoutForm

setLayoutForm

getLayoutSubtotalLocation

setLayoutSubtotalLocation

getName

setName

getNumberFormat

setNumberFormat

getOrientation

setOrientation

getPosition

setPosition

getRepeatLabels

setRepeatLabels

getShowAllItems

setShowAllItems

getSourceName

getSubtotals

setSubtotals

autoSort

autoSort

clearAllFilters

clearManualFilter

getPivotItems

getCalculatedItems