new GlobalizationSettings()

Methods

compare(v1, v2, ignoreCase) → Number

Compares two string values according to certain collation rules.

Parameters

Name Type Optional Description

v1

String

 

the first string

v2

String

 

the second string

ignoreCase

boolean

 

whether ignore case when comparing values

Returns

Number Integer that indicates the lexical relationship between the two comparands

getAllName() → String

Gets the name of "(All)" label in the PivotTable.

Returns

String The name of "(All)" label

getBooleanValueString(bv) → String

Gets the display string value for cell's boolean value

Parameter

Name Type Optional Description

bv

boolean

 

boolean value

Returns

String Default returns "TRUE" for true value and "FALSE" for false value.

getChartSettings()

Gets or sets the Chart of thisChartGlobalizationSettings

getCollationKey(v, ignoreCase) → IComparable

Transforms the string into a comparable object according to certain collation rules.

Parameters

Name Type Optional Description

v

String

 

String value needs to be compared with others.

ignoreCase

boolean

 

whether ignore case when comparing values

Returns

IComparable Object can be used to compare or sort string values

getColumnLabelsOfPivotTable() → String

Gets the name of "Column Labels" label in the PivotTable.

Returns

String The name of column labels

getColumnLablesName()

Gets the name of "Column Labels" label in the PivotTable. NOTE: This member is now obsolete. Instead, please use GlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since September 2020. Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of column labels

getColumnSeparatorOfFormulaArray()

Gets the separator for the items in array's row data in formula.

getCommentTitleName(type) → String

Gets the locale dependent comment title name according to comment title type.

Parameter

Name Type Optional Description

type

Number

 

CommentTitleType

Returns

String 

getEmptyDataName() → String

Gets the name of "(blank)" label in the PivotTable.

Returns

String The name of empty data

getErrorValueString(err) → String

Gets the display string value for cell's error value

Parameter

Name Type Optional Description

err

String

 

error values such as #VALUE!,#NAME?

Returns

String Default returns the error value itself

getGrandTotalName(functionType) → String

Gets the grand total name of the function.

Parameter

Name Type Optional Description

functionType

Number

 

ConsolidationFunction

Returns

String The grand total name of the function.

getListSeparator()

Gets the separator for list, parameters of function, ...etc.

getLocalBuiltInName(standardName) → String

Gets the locale dependent text for built-in Name according to given standard text.

Parameter

Name Type Optional Description

standardName

String

 

Standard(en-US locale) text of built-in Name.

Returns

String Locale dependent text. The locale was specified by the Workbook for which this settings is used.

getLocalFunctionName(standardName) → String

Gets the locale dependent function name according to given standard function name.

Parameter

Name Type Optional Description

standardName

String

 

Standard(en-US locale) function name.

Returns

String Locale dependent function name. The locale was specified by the Workbook for which this settings is used.

getMultipleItemsName() → String

Gets the name of "(Multiple Items)" label in the PivotTable.

Returns

String The name of "(Multiple Items)" label

getOtherName() → String

Gets the name of "Other" labels for Pie charts.

Returns

String 

getPivotGrandTotalName() → String

Gets the name of "Grand Total" label in the PivotTable.

Returns

String The name of "Grand Total" label

getPivotTotalName() → String

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

Returns

String The name of "Total" label

getProtectionNameOfPivotTable() → String

Gets the protection name in the PivotTable.

Returns

String The protection name of PivotTable

getRowLabelsNameOfPivotTable() → String

Gets the name of "Row Labels" label in the PivotTable.

Returns

String The name of row labels

getRowLablesName()

Gets the name of "Row Labels" label in the PivotTable. NOTE: This member is now obsolete. Instead, please use GlobalizationSettings.GetRowLabelsOfPivotTable() method. This property will be removed 12 months later since September 2020. Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of row labels

getRowSeparatorOfFormulaArray()

Gets the separator for rows in array data in formula.

getStandardBuiltInName(localName) → String

Gets the standard text of built-in Name according to given locale dependent text.

Parameter

Name Type Optional Description

localName

String

 

Locale dependent text of built-in Name. The locale was specified by the Workbook for which this settings is used.

Returns

String Standard(en-US locale) text.

getStandardFunctionName(localName) → String

Gets the standard function name according to given locale dependent function name.

Parameter

Name Type Optional Description

localName

String

 

Locale dependent function name. The locale was specified by the Workbook for which this settings is used.

Returns

String Standard(en-US locale) function name.

getStandardHeaderFooterFontStyleName(localfontStyleName) → String

Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.

Parameter

Name Type Optional Description

localfontStyleName

String

 

Locale font style name for Header/Footer.

Returns

String Standard English font style name(Regular, Bold, Italic)

getSubTotalName(subTotalType) → String

Gets the name of PivotFieldSubtotalType type in the PivotTable.

Parameter

Name Type Optional Description

subTotalType

Number

 

PivotFieldSubtotalType

Returns

String The name of PivotFieldSubtotalType type

getTableRowTypeOfAll() → String

Gets the type name of table rows that consists of all rows in referenced table. Default is "All", so in formula "#All" represents all rows in referenced table.

Returns

String the type name of table rows

getTableRowTypeOfCurrent() → String

Gets the type name of table rows that consists of the current row in referenced table. Default is "This Row", so in formula "#This Row" represents the current row in referenced table.

Returns

String the type name of table rows

getTableRowTypeOfData() → String

Gets the type name of table rows that consists of data region of referenced table. Default is "Data", so in formula "#Data" represents the data region of the table.

Returns

String the type name of table rows

getTableRowTypeOfHeaders() → String

Gets the type name of table rows that consists of the table header. Default is "Headers", so in formula "#Headers" represents the table header.

Returns

String the type name of table rows

getTableRowTypeOfTotals() → String

Gets the type name of table rows that consists of the total row of referenced table. Default is "Totals", so in formula "#Totals" represents the total row of referenced table.

Returns

String the type name of table rows

getTotalName(functionType) → String

Gets the total name of the function.

Parameter

Name Type Optional Description

functionType

Number

 

ConsolidationFunction

Returns

String The total name of the function.

setChartSettings()

Gets or sets the Chart of thisChartGlobalizationSettings