GlobalizationSettings

GlobalizationSettings class

Represents the globalization settings.

new GlobalizationSettings()

Methods

Name	Description
compare(v1, v2, ignoreCase)	Compares two string values according to certain collation rules.
getAllName()	Gets the name of “(All)” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use GlobalizationSe
getBooleanValueString(bv)	Gets the display string value for cell’s boolean value
getChartSettings()	Gets or sets the globalization settings for Chart.
getCollationKey(v, ignoreCase)	Transforms the string into a comparable object according to certain collation rules.
getColumnLabelsOfPivotTable()	Gets the name of “Column Labels” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGl
getColumnSeparatorOfFormulaArray()	Gets the separator for the items in array’s row data in formula.
getCommentTitleName(type)	Gets the locale dependent comment title name according to comment title type.
getDataFieldHeaderNameOfPivotTable()	Gets the the name of the value area field header in the PivotTable. NOTE: This member is now obsolete. Instead, please u
getDefaultSheetName()	Gets the default sheet name for adding worksheet automatically. Default is “Sheet”. The automatically added(such as by W
getEmptyDataName()	Gets the name of “(blank)” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlobaliz
getErrorValueString(err)	Gets the display string value for cell’s error value
getGrandTotalName(functionType)	Gets the grand total name of the function.
getListSeparator()	Gets the separator for list, parameters of function, …etc.
getLocalBuiltInName(standardName)	Gets the locale dependent text for built-in Name according to given standard text.
getLocalFunctionName(standardName)	Gets the locale dependent function name according to given standard function name.
getMultipleItemsName()	Gets the name of “(Multiple Items)” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use Pivo
getPivotGrandTotalName()	Gets the name of “Grand Total” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlob
getPivotSettings()	Gets or sets the globalization settings for pivot table.
getPivotTotalName()	Gets the name of “Total” label in the PivotTable. You need to override this method when the PivotTable contains two or m
getProtectionNameOfPivotTable()	Gets the protection name in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSet
getRowLabelsNameOfPivotTable()	Gets the name of “Row Labels” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGloba
getRowSeparatorOfFormulaArray()	Gets the separator for rows in array data in formula.
getStandardBuiltInName(localName)	Gets the standard text of built-in Name according to given locale dependent text.
getStandardFunctionName(localName)	Gets the standard function name according to given locale dependent function name.
getStandardHeaderFooterFontStyleName(localfontStyleName)	Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name
getSubTotalName(subTotalType)	Gets the name of PivotFieldSubtotalType type in the PivotTable. NOTE: This member is now obsolete. Instead, please use P
getTableRowTypeOfAll()	Gets the type name of table rows that consists of all rows in referenced table. Default is “All”, so in formula “#All” r
getTableRowTypeOfCurrent()	Gets the type name of table rows that consists of the current row in referenced table. Default is “This Row”, so in form
getTableRowTypeOfData()	Gets the type name of table rows that consists of data region of referenced table. Default is “Data”, so in formula “#Da
getTableRowTypeOfHeaders()	Gets the type name of table rows that consists of the table header. Default is “Headers”, so in formula “#Headers” repre
getTableRowTypeOfTotals()	Gets the type name of table rows that consists of the total row of referenced table. Default is “Totals”, so in formula
getTotalName(functionType)	Gets the total name of the function.
setChartSettings()	Gets or sets the globalization settings for Chart.
setPivotSettings()	Gets or sets the globalization settings for pivot table.

compare(v1, v2, ignoreCase)

Compares two string values according to certain collation rules.

Parameter	Type	Description
v1	String	the first string
v2	String	the second string
ignoreCase	boolean	whether ignore case when comparing values

Returns: Number — Number Integer that indicates the lexical relationship between the two comparands

getAllName()

Gets the name of “(All)” 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 December 2022. Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of “(All)” label

getBooleanValueString(bv)

Gets the display string value for cell’s boolean value

Parameter	Type	Description
bv	boolean	boolean value

Returns: String — String By default returns “TRUE” for true value and “FALSE” for false value.

getChartSettings()

Gets or sets the globalization settings for Chart.

getCollationKey(v, ignoreCase)

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

Parameter	Type	Description
v	String	String value needs to be compared with others.
ignoreCase	boolean	whether ignore case when comparing values

Returns: IComparable — IComparable Object can be used to compare or sort string values

getColumnLabelsOfPivotTable()

Gets the name of “Column Labels” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. 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)

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

Parameter	Type	Description
type	Number	CommentTitleType

Returns: String — String

getDataFieldHeaderNameOfPivotTable()

Gets the the name of the value area field header in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of data field header name

getDefaultSheetName()

Gets the default sheet name for adding worksheet automatically. Default is “Sheet”. The automatically added(such as by WorksheetCollection.add()) sheet’s name will be the specified name plus sequence number. For example, for Germany user maybe wants the sheet name to be “Tabellenblatt2” instead of “Sheet2”. Then user may implement this method to return “Tabellenblatt”.@return {String} the default sheet name for adding worksheet automatically

getEmptyDataName()

Gets the name of “(blank)” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of empty data

getErrorValueString(err)

Gets the display string value for cell’s error value

Parameter	Type	Description
err	String	error values such as #VALUE!,#NAME?

Returns: String — String By default returns the error value itself

getGrandTotalName(functionType)

Gets the grand total name of the function.

Parameter	Type	Description
functionType	Number	ConsolidationFunction

Returns: String — String The grand total name of the function.

getListSeparator()

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

getLocalBuiltInName(standardName)

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

Parameter	Type	Description
standardName	String	Standard(en-US locale) text of built-in Name.

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

getLocalFunctionName(standardName)

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

Parameter	Type	Description
standardName	String	Standard(en-US locale) function name.

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

getMultipleItemsName()

Gets the name of “(Multiple Items)” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of “(Multiple Items)” label

getPivotGrandTotalName()

Gets the name of “Grand Total” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of “Grand Total” label

getPivotSettings()

Gets or sets the globalization settings for pivot table.

getPivotTotalName()

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. NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of “Total” label

getProtectionNameOfPivotTable()

Gets the protection name in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetTextOfProtectedName(string) method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.@return {String} The protection name of PivotTable

getRowLabelsNameOfPivotTable()

Gets the name of “Row Labels” label in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. 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)

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

Parameter	Type	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 — String Standard(en-US locale) text.

getStandardFunctionName(localName)

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

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

Returns: String — String Standard(en-US locale) function name.

getStandardHeaderFooterFontStyleName(localfontStyleName)

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

Parameter	Type	Description
localfontStyleName	String	Locale font style name for Header/Footer.

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

getSubTotalName(subTotalType)

Gets the name of PivotFieldSubtotalType type in the PivotTable. NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Parameter	Type	Description
subTotalType	Number	PivotFieldSubtotalType

Returns: String — String The name of PivotFieldSubtotalType type

getTableRowTypeOfAll()

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.