GlobalizationSettings
GlobalizationSettings class
Represents the globalization settings.
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. |
| 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. |
| abstract getTotalName(ConsolidationFunction) | Gets the total name of the function. |
| abstract getGrandTotalName(ConsolidationFunction) | Gets the grand total name of the function. |
| abstract getDefaultSheetName() | Gets the default sheet name for adding worksheet automatically. Default is “Sheet”. |
| abstract 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. |
| abstract 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. |
| abstract 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. |
| abstract 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. |
| abstract 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. |
| abstract getErrorValueString(string) | Gets the display string value for cell’s error value |
| abstract getBooleanValueString(boolean) | Gets the display string value for cell’s boolean value |
| abstract getLocalFunctionName(string) | Gets the locale dependent function name according to given standard function name. |
| abstract getStandardFunctionName(string) | Gets the standard function name according to given locale dependent function name. |
| abstract getLocalBuiltInName(string) | Gets the locale dependent text for built-in Name according to given standard text. |
| abstract getStandardBuiltInName(string) | Gets the standard text of built-in Name according to given locale dependent text. |
| abstract getStandardHeaderFooterFontStyleName(string) | Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name. |
| abstract getCommentTitleName(CommentTitleType) | Gets the locale dependent comment title name according to comment title type. |
| abstract compare(string, string, boolean) | Compares two string values according to certain collation rules. |
constructor()
Default Constructor.
constructor();
getChartSettings()
Gets or sets the globalization settings for Chart.
getChartSettings() : ChartGlobalizationSettings;
Returns
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
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. |
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;
getTotalName(ConsolidationFunction)
Gets the total name of the function.
abstract 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.
abstract 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”.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract getTableRowTypeOfCurrent() : string;
Returns
the type name of table rows
getErrorValueString(string)
Gets the display string value for cell’s error value
abstract 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
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract getCommentTitleName(type: CommentTitleType) : string;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | CommentTitleType |
compare(string, string, boolean)
Compares two string values according to certain collation rules.
abstract 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