PivotTableFormatCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase

public class PivotTableFormatCollection extends CollectionBase

Represents the collection of formats applied to PivotTable.

Methods

Method	Description
add()	Add a PivotTableFormat.
add(Object o)	Adds an item to the CollectionBase instance.
clear()	Removes all objects from the CollectionBase instance.
contains(Object o)	Return whether instance contains this object
equals(Object arg0)
formatArea(int axisType, int fieldPosition, int subtotalType, int selectionType, boolean isGrandRow, boolean isGrandColumn, Style style)	Formats selected area.
get(int index)	Gets the format by the index.
getClass()
getCount()	Gets the number of elements contained in the CollectionBase instance.
hashCode()
indexOf(Object o)	Determines the index of a specific item in the CollectionBase instance.
iterator()	Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
removeAt(int index)	Removes the item at the specified index.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add()

public int add()

Add a PivotTableFormat.

Returns: int - The index of new format.

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	The Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

clear()

public void clear()

Removes all objects from the CollectionBase instance.

contains(Object o)

public boolean contains(Object o)

Return whether instance contains this object

Parameters:

Parameter	Type	Description
o	java.lang.Object	test object

Returns: boolean - Whether instance contains this object

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

formatArea(int axisType, int fieldPosition, int subtotalType, int selectionType, boolean isGrandRow, boolean isGrandColumn, Style style)

public PivotTableFormat formatArea(int axisType, int fieldPosition, int subtotalType, int selectionType, boolean isGrandRow, boolean isGrandColumn, Style style)

Formats selected area.

Parameters:

Parameter	Type	Description
axisType	int	PivotFieldType. The region of the PivotTable to which this rule applies.
fieldPosition	int	Position of the field within the axis to which this rule applies.
subtotalType	int	PivotFieldSubtotalType. The subtotal filter type of the pivot field
selectionType	int	PivotTableSelectionType. Indicates how to select data.
isGrandRow	boolean	Indicates whether selecting grand total rows.
isGrandColumn	boolean	Indicates whether selecting grand total columns.
style	Style	The style which appies to the area of the pivot table.

Returns: PivotTableFormat -

get(int index)

public PivotTableFormat get(int index)

Gets the format by the index.

Parameters:

Parameter	Type	Description
index	int	The index.

Returns: PivotTableFormat -

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCount()

public int getCount()

Gets the number of elements contained in the CollectionBase instance.

Returns: int - The number of elements contained in the CollectionBase instance.

hashCode()

public native int hashCode()

Returns: int

indexOf(Object o)

public int indexOf(Object o)

Determines the index of a specific item in the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	Determines the index of a specific item in the CollectionBase instance.

Returns: int - The index of value if found in the list; otherwise, -1.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

Returns: java.util.Iterator - An iterator for the CollectionBase instance.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

removeAt(int index)

public void removeAt(int index)

Removes the item at the specified index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index of the item to remove.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int