GlobalizationSettings

GlobalizationSettings class

Represents the globalization settings.

abstract class GlobalizationSettings;

Constructors

Name	Description
constructor()	Default Constructor.

Methods

Method	Description
getChartSettings()	Gets or sets the globalization settings for Chart.
setChartSettings(ChartGlobalizationSettings)	Gets or sets the globalization settings for Chart.
getPivotSettings()	Gets or sets the globalization settings for pivot table.
setPivotSettings(PivotGlobalizationSettings)	Gets or sets the globalization settings for pivot table.
getTotalName(ConsolidationFunction)	Gets the total name of the function.
getGrandTotalName(ConsolidationFunction)	Gets the grand total name of the function.
getDefaultSheetName()	Gets the default sheet name for adding worksheet automatically. Default is “Sheet”.
getTableRowTypeOfHeaders()	Gets the type name of table rows that consists of the table header. Default is “Headers”, so in formula “#Headers” represents the table header.
getTableRowTypeOfData()	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.
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.
getTableRowTypeOfTotals()	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.
getTableRowTypeOfCurrent()	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.
getErrorValueString(string)	Gets the display string value for cell’s error value
getBooleanValueString(boolean)	Gets the display string value for cell’s boolean value
getLocalFunctionName(string)	Gets the locale dependent function name according to given standard function name.
getStandardFunctionName(string)	Gets the standard function name according to given locale dependent function name.
getLocalBuiltInName(string)	Gets the locale dependent text for built-in Name according to given standard text.
getStandardBuiltInName(string)	Gets the standard text of built-in Name according to given locale dependent text.
getStandardHeaderFooterFontStyleName(string)	Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
getCommentTitleName(CommentTitleType)	Gets the locale dependent comment title name according to comment title type.
compare(string, string, boolean)	Compares two string values according to certain collation rules.
abstract getListSeparator()	Gets the separator for list, parameters of function, …etc.
abstract getRowSeparatorOfFormulaArray()	Gets the separator for rows in array data in formula.
abstract getColumnSeparatorOfFormulaArray()	Gets the separator for the items in array’s row data in formula.

constructor()

Default Constructor.

constructor();

getChartSettings()

Gets or sets the globalization settings for Chart.

getChartSettings() : ChartGlobalizationSettings;

Returns

ChartGlobalizationSettings

setChartSettings(ChartGlobalizationSettings)

Gets or sets the globalization settings for Chart.

setChartSettings(value: ChartGlobalizationSettings) : void;

Parameters:

Parameter	Type	Description
value	ChartGlobalizationSettings	The value to set.

getPivotSettings()

Gets or sets the globalization settings for pivot table.

getPivotSettings() : PivotGlobalizationSettings;

Returns

PivotGlobalizationSettings

setPivotSettings(PivotGlobalizationSettings)

Gets or sets the globalization settings for pivot table.

setPivotSettings(value: PivotGlobalizationSettings) : void;

Parameters:

Parameter	Type	Description
value	PivotGlobalizationSettings	The value to set.

getTotalName(ConsolidationFunction)

Gets the total name of the function.

getTotalName(functionType: ConsolidationFunction) : string;

Parameters:

Parameter	Type	Description
functionType	ConsolidationFunction	The function type.

Returns

The total name of the function.

getGrandTotalName(ConsolidationFunction)

Gets the grand total name of the function.

getGrandTotalName(functionType: ConsolidationFunction) : string;

Parameters:

Parameter	Type	Description
functionType	ConsolidationFunction	The function type.

Returns

The grand total name of the function.

getDefaultSheetName()

Gets the default sheet name for adding worksheet automatically. Default is “Sheet”.

getDefaultSheetName() : string;

Returns

the default sheet name for adding worksheet automatically

Remarks

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”.

getTableRowTypeOfHeaders()

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

getTableRowTypeOfHeaders() : string;

Returns

the type name of table rows

getTableRowTypeOfData()

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.

getTableRowTypeOfData() : string;

Returns

the type name of table rows

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.

getTableRowTypeOfAll() : string;

Returns

the type name of table rows

getTableRowTypeOfTotals()

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.

getTableRowTypeOfTotals() : string;

Returns

the type name of table rows

getTableRowTypeOfCurrent()

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.

getTableRowTypeOfCurrent() : string;

Returns

the type name of table rows

getErrorValueString(string)

Gets the display string value for cell’s error value

getErrorValueString(err: string) : string;

Parameters:

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

Returns

By default returns the error value itself

getBooleanValueString(boolean)

Gets the display string value for cell’s boolean value

getBooleanValueString(bv: boolean) : string;

Parameters:

Parameter	Type	Description
bv	boolean	boolean value

Returns

By default returns “TRUE” for true value and “FALSE” for false value.

getLocalFunctionName(string)

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

getLocalFunctionName(standardName: string) : string;

Parameters:

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

Returns

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

getStandardFunctionName(string)

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

getStandardFunctionName(localName: string) : string;

Parameters:

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

Returns

Standard(en-US locale) function name.

getLocalBuiltInName(string)

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

getLocalBuiltInName(standardName: string) : string;

Parameters:

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

Returns

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

getStandardBuiltInName(string)

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

getStandardBuiltInName(localName: string) : string;

Parameters:

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

Standard(en-US locale) text.

getStandardHeaderFooterFontStyleName(string)

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

getStandardHeaderFooterFontStyleName(localfontStyleName: string) : string;

Parameters:

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

Returns

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

getCommentTitleName(CommentTitleType)

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

getCommentTitleName(type: CommentTitleType) : string;

Parameters:

Parameter	Type	Description
type	CommentTitleType

compare(string, string, boolean)

Compares two string values according to certain collation rules.

compare(v1: string, v2: string, ignoreCase: boolean) : number;

Parameters:

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

Returns

Integer that indicates the lexical relationship between the two comparands

getListSeparator()

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

abstract getListSeparator() : string;

getRowSeparatorOfFormulaArray()

Gets the separator for rows in array data in formula.

abstract getRowSeparatorOfFormulaArray() : string;

getColumnSeparatorOfFormulaArray()

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

abstract getColumnSeparatorOfFormulaArray() : string;