asposecells.api

asposecells.api

Class PivotFieldCollection

Represents a collection of all the PivotField objects in the PivotTable's specific PivotFields type.

Property Getters/Setters Summary
methodgetCount()
Gets the count of the pivotFields.
methodgetType()
Gets the PivotFields type. The value of the property is PivotFieldType integer constant.
methodget(index)
Gets the PivotField Object at the specific index.
methodget(name)
Gets the PivotField Object of the specific name.
 
Method Summary
methodadd(pivotField)
Adds a PivotField Object to the specific type PivotFields.
methodaddByBaseIndex(baseFieldIndex)
Adds a PivotField Object to the specific type PivotFields.
methodclear()
clear all fields of PivotFieldCollection
methoditerator()
Gets an enumerator over the elements in this collection in proper sequence.
methodmove(currPos, destPos)
Moves the PivotField from current position to destination position
 

    • Property Getters/Setters Detail

      • getType : int 

        int getType()
        Gets the PivotFields type. The value of the property is PivotFieldType integer constant.

      • getCount : int 

        int getCount()
        Gets the count of the pivotFields.

    • Method Detail

      • iterator

        Iterator iterator()
        Gets an enumerator over the elements in this collection in proper sequence.
        Returns:
        enumerator

      • addByBaseIndex

        int addByBaseIndex(baseFieldIndex)
        Adds a PivotField Object to the specific type PivotFields.
        Parameters:
        baseFieldIndex: int - field index in the base PivotFields.
        Returns:
        the index of the PivotField Object in this PivotFields.

      • add

        int add(pivotField)
        Adds a PivotField Object to the specific type PivotFields.
        Parameters:
        pivotField: PivotField - a PivotField Object.
        Returns:
        the index of the PivotField Object in this PivotFields.

      • clear

         clear()
        clear all fields of PivotFieldCollection

      • move

         move(currPos, destPos)
        Moves the PivotField from current position to destination position
        Parameters:
        currPos: int - Current position of PivotField based on zero
        destPos: int - Destination position of PivotField based on zero