Namespace EasyXLS.PivotTables

Class ExcelValueField

System.Object

EasyXLS.PivotTables.ExcelValueField

public class ExcelValueField
extends System.Object

This class stores pivot table value field information like name, basic field, subtotal and number format.

Constructor Summary

Constructors

Constructor	Description
ExcelValueField()	Defines an instance of the pivot table value field.

Method Summary

Modifier and Type	Method	Description
ExcelValueField	Clone()	Creates and returns a copy of this object.
System.String	getBasicField()	Returns the name of the field.
System.String	getCustomName()	Returns the name of the pivot table value field.
System.String	getFormat()	Returns the number format of the value field.
int	getSubtotal()	Returns the subtotal applied on the value field.
void	setCustomName(System.String customName)	Sets the name of the pivot table value field.
void	setFormat(System.String format)	Sets the number format of the value field.
void	setSubtotal(int subtotal)	Sets the subtotal applied on the value field.

Methods inherited from class System.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExcelValueField

public ExcelValueField()

Defines an instance of the pivot table value field.

Method Details

getCustomName

public System.String getCustomName()

Returns the name of the pivot table value field.

Returns:

the name of the pivot table value field

See Also:

• setCustomName(System.String)
• getBasicField()

setCustomName

public void setCustomName(System.String customName)

Sets the name of the pivot table value field.

Parameters:

customName - the name of the pivot table value field

See Also:

• getCustomName()

getBasicField

public System.String getBasicField()

Returns the name of the field.

Returns:

the name of the field

See Also:

• setCustomName(System.String)
• getCustomName()

getSubtotal

public int getSubtotal()

Returns the subtotal applied on the value field.

Returns:

the subtotal applied on the value field. Possible values are available in PivotTable class.

See Also:

• setSubtotal(int)

setSubtotal

public void setSubtotal(int subtotal)

Sets the subtotal applied on the value field.

Parameters:

subtotal - - the subtotal to be applied. Possible values are available in PivotTable class.

See Also:

• getSubtotal()

getFormat

public System.String getFormat()

Returns the number format of the value field. Possible values are available in Format class.

Returns:

the number format of the value field

See Also:

• setFormat(System.String)

setFormat

public void setFormat(System.String format)

Sets the number format of the value field.

Parameters:

format - the number format of the value field. Possible values are available in Format class.

See Also:

• getFormat()

Clone

public ExcelValueField Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.