SettablePivotGlobalizationSettings

SettablePivotGlobalizationSettings class

Implementation of PivotGlobalizationSettings that supports user to set/change pre-defined texts.

class SettablePivotGlobalizationSettings;

Constructors

Constructor	Description
constructor()	Default Constructor.

Methods

Method	Description
setTextOfTotal(string)	Sets the text of “Total” label in the PivotTable.
setTextOfGrandTotal(string)	Sets the text of “Grand Total” label in the PivotTable.
setTextOfMultipleItems(string)	Sets the text of “(Multiple Items)” label in the PivotTable.
setTextOfAll(string)	Sets the text of “(All)” label in the PivotTable.
setTextOfProtectedName(string, string)	Sets the text for specific protected name.
setTextOfColumnLabels(string)	Gets the text of “Column Labels” label in the PivotTable.
setTextOfRowLabels(string)	Sets the text of “Row Labels” label in the PivotTable.
setTextOfEmptyData(string)	Sets the text of “(blank)” label in the PivotTable.
setTextOfDataFieldHeader(string)	Sets the the text of the value area field header in the PivotTable.
setTextOfSubTotal(PivotFieldSubtotalType, string)	Sets the text of PivotFieldSubtotalType type in the PivotTable.
isNull()	Checks whether the implementation object is null.
getTextOfTotal()	Gets the text of “Total” label in the PivotTable. You need to override this method when the PivotTable contains two or more PivotFields in the data area.
getTextOfGrandTotal()	Gets the text of “Grand Total” label in the PivotTable.
getTextOfMultipleItems()	Gets the text of “(Multiple Items)” label in the PivotTable.
getTextOfAll()	Gets the text of “(All)” label in the PivotTable.
getTextOfProtectedName(string)	Gets the text for specified protected name.
getTextOfColumnLabels()	Gets the text of “Column Labels” label in the PivotTable.
getTextOfRowLabels()	Gets the text of “Row Labels” label in the PivotTable.
getTextOfEmptyData()	Gets the text of “(blank)” label in the PivotTable.
getTextOfDataFieldHeader()	Gets the the text of the value area field header in the PivotTable.
getTextOfSubTotal(PivotFieldSubtotalType)	Gets the text of PivotFieldSubtotalType type in the PivotTable.

constructor()

Default Constructor.

constructor();

setTextOfTotal(string)

Sets the text of “Total” label in the PivotTable.

setTextOfTotal(text: string) : void;

Parameters:

Parameter	Type	Description
text	string	custom text

setTextOfGrandTotal(string)

Sets the text of “Grand Total” label in the PivotTable.

setTextOfGrandTotal(text: string) : void;

Parameters:

Parameter	Type	Description
text	string	custom text

setTextOfMultipleItems(string)

Sets the text of “(Multiple Items)” label in the PivotTable.

setTextOfMultipleItems(text: string) : void;

Parameters:

Parameter	Type	Description
text	string	custom text

setTextOfAll(string)

Sets the text of “(All)” label in the PivotTable.

setTextOfAll(text: string) : void;

Parameters:

Parameter	Type	Description
text	string	custom text

setTextOfProtectedName(string, string)

Sets the text for specific protected name.

setTextOfProtectedName(protectedName: string, text: string) : void;

Parameters:

Parameter	Type	Description
protectedName	string	The protected name in PivotTable.
text	string	The local prorected names of PivotTable.

setTextOfColumnLabels(string)

Gets the text of “Column Labels” label in the PivotTable.

setTextOfColumnLabels(text: string) : void;

Parameters:

Parameter	Type	Description
text	string	The text of column labels

setTextOfRowLabels(string)

Sets the text of “Row Labels” label in the PivotTable.

setTextOfRowLabels(text: string) : void;

Parameters:

Parameter	Type	Description
text	string	The text of row labels

setTextOfEmptyData(string)

Sets the text of “(blank)” label in the PivotTable.

setTextOfEmptyData(text: string) : void;

Parameters:

Parameter	Type	Description
text	string	The text of empty data

setTextOfDataFieldHeader(string)

Sets the the text of the value area field header in the PivotTable.

setTextOfDataFieldHeader(text: string) : void;

Parameters:

Parameter	Type	Description
text	string	The text of data field header name

setTextOfSubTotal(PivotFieldSubtotalType, string)

Sets the text of PivotFieldSubtotalType type in the PivotTable.

setTextOfSubTotal(subTotalType: PivotFieldSubtotalType, text: string) : void;

Parameters:

Parameter	Type	Description
subTotalType	PivotFieldSubtotalType	The PivotFieldSubtotalType
text	string	The text of given type

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getTextOfTotal()

Gets the text of “Total” label in the PivotTable. You need to override this method when the PivotTable contains two or more PivotFields in the data area.

getTextOfTotal() : string;

Returns

The text of “Total” label

getTextOfGrandTotal()

Gets the text of “Grand Total” label in the PivotTable.

getTextOfGrandTotal() : string;

Returns

The text of “Grand Total” label

getTextOfMultipleItems()

Gets the text of “(Multiple Items)” label in the PivotTable.

getTextOfMultipleItems() : string;

Returns

The text of “(Multiple Items)” label

getTextOfAll()

Gets the text of “(All)” label in the PivotTable.

getTextOfAll() : string;

Returns

The text of “(All)” label

getTextOfProtectedName(string)

Gets the text for specified protected name.

getTextOfProtectedName(protectedName: string) : string;

Parameters:

Parameter	Type	Description
protectedName	string	The protected name in PivotTable.

Returns

The local prorected names of PivotTable.

Remarks

In Ms Excel, some names are not allowed to be used as the name of PivotFields in PivotTable. They are different in different region, user may specify them explicitly according to the used region.

getTextOfColumnLabels()

Gets the text of “Column Labels” label in the PivotTable.

getTextOfColumnLabels() : string;

Returns

The text of column labels

getTextOfRowLabels()

Gets the text of “Row Labels” label in the PivotTable.

getTextOfRowLabels() : string;

Returns

The text of row labels

getTextOfEmptyData()

Gets the text of “(blank)” label in the PivotTable.

getTextOfEmptyData() : string;

Returns

The text of empty data

getTextOfDataFieldHeader()

Gets the the text of the value area field header in the PivotTable.

getTextOfDataFieldHeader() : string;

Returns

The text of data field header name

getTextOfSubTotal(PivotFieldSubtotalType)

Gets the text of PivotFieldSubtotalType type in the PivotTable.

getTextOfSubTotal(subTotalType: PivotFieldSubtotalType) : string;

Parameters:

Parameter	Type	Description
subTotalType	PivotFieldSubtotalType	The PivotFieldSubtotalType

Returns

The text of given type