SettableGlobalizationSettings

SettableGlobalizationSettings class

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

class SettableGlobalizationSettings;

Constructors

Name	Description
constructor()	Default Constructor.

Methods

Method	Description
getListSeparator()	Gets the separator for list, parameters of function, …etc.
getRowSeparatorOfFormulaArray()	Gets the separator for rows in array data in formula.
getColumnSeparatorOfFormulaArray()	Gets the separator for the items in array’s row data in formula.
getTotalName(ConsolidationFunction)	Gets the total name of specific function.
setTotalName(ConsolidationFunction, string)	Sets the total name of specific function.
getGrandTotalName(ConsolidationFunction)	Gets the grand total name of the function.
setGrandTotalName(ConsolidationFunction, string)	Sets the grand total name of specific function.
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.
setTableRowTypeOfHeaders(string)	Sets the type name of table rows that consists of 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.
setTableRowTypeOfData(string)	Sets the type name of table rows that consists of data region of referenced table.
getTableRowTypeOfAll()	Gets the type name of table rows that consists of all rows in referenced table.
setTableRowTypeOfAll(string)	Sets the type name of table rows that consists of all rows in referenced table.
getTableRowTypeOfTotals()	Gets the type name of table rows that consists of the total row of referenced table.
setTableRowTypeOfTotals(string)	Sets the type name of table rows that consists of the total row of referenced table.
getTableRowTypeOfCurrent()	Gets the type name of table rows that consists of the current row in referenced table.
setTableRowTypeOfCurrent(string)	Sets the type name of table rows that consists of 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
setBooleanValueString(boolean, string)	Sets the display string value for cell’s boolean value
getLocalFunctionName(string)	Gets the locale dependent function name according to given standard function name.
setLocalFunctionName(string, string, boolean)	Sets the locale dependent function name corresponding to given standard function name.
getStandardFunctionName(string)	Gets the standard function name according to given locale dependent function name.
setStandardFunctionName(string, string, boolean)	Sets the locale dependent function name according to given standard function name.
getLocalBuiltInName(string)	Gets the locale dependent text for built-in Name according to given standard text.
setLocalBuiltInName(string, string, boolean)	Sets the locale dependent text for the built-in name with given standard name text.
getStandardBuiltInName(string)	Gets the standard text of built-in Name according to given locale dependent text.
setStandardBuiltInName(string, string, boolean)	Sets the locale dependent function name according to given standard function name.
setListSeparator(string)	Sets the separator for list, parameters of function, …etc.
setRowSeparatorOfFormulaArray(string)	Sets the separator for rows in array data in formula.
setColumnSeparatorOfFormulaArray(string)	Sets the separator for the items in array’s row data in formula.
getStandardHeaderFooterFontStyleName(string)	Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
setStandardHeaderFooterFontStyleName(string, string)	Sets the locale dependent function name according to given standard function name.
getCommentTitleName(CommentTitleType)	Gets the locale dependent comment title name according to comment title type.
setCommentTitleName(CommentTitleType, string)	Gets the locale dependent comment title name according to comment title type.
isNull()	Checks whether the implementation object is null.

constructor()

Default Constructor.

constructor();

getListSeparator()

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

getListSeparator() : string;

getRowSeparatorOfFormulaArray()

Gets the separator for rows in array data in formula.

getRowSeparatorOfFormulaArray() : string;

getColumnSeparatorOfFormulaArray()

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

getColumnSeparatorOfFormulaArray() : string;

getTotalName(ConsolidationFunction)

Gets the total name of specific function.

getTotalName(functionType: ConsolidationFunction) : string;

Parameters:

Parameter	Type	Description
functionType	ConsolidationFunction	The function type.

Returns

The total name of the function.

setTotalName(ConsolidationFunction, string)

Sets the total name of specific function.

setTotalName(functionType: ConsolidationFunction, name: string) : void;

Parameters:

Parameter	Type	Description
functionType	ConsolidationFunction	The function type.
name	string	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.

setGrandTotalName(ConsolidationFunction, string)

Sets the grand total name of specific function.

setGrandTotalName(functionType: ConsolidationFunction, name: string) : void;

Parameters:

Parameter	Type	Description
functionType	ConsolidationFunction	The function type.
name	string	The grand total name of the function.

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

setTableRowTypeOfHeaders(string)

Sets the type name of table rows that consists of the table header.

setTableRowTypeOfHeaders(name: string) : void;

Parameters:

Parameter	Type	Description
name	string	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

setTableRowTypeOfData(string)

Sets the type name of table rows that consists of data region of referenced table.

setTableRowTypeOfData(name: string) : void;

Parameters:

Parameter	Type	Description
name	string	the type name of table rows

getTableRowTypeOfAll()

Gets the type name of table rows that consists of all rows in referenced table.

getTableRowTypeOfAll() : string;

Returns

the type name of table rows

setTableRowTypeOfAll(string)

Sets the type name of table rows that consists of all rows in referenced table.

setTableRowTypeOfAll(name: string) : void;

Parameters:

Parameter	Type	Description
name	string	the type name of table rows

getTableRowTypeOfTotals()

Gets the type name of table rows that consists of the total row of referenced table.

getTableRowTypeOfTotals() : string;

Returns

the type name of table rows

setTableRowTypeOfTotals(string)

Sets the type name of table rows that consists of the total row of referenced table.

setTableRowTypeOfTotals(name: string) : void;

Parameters:

Parameter	Type	Description
name	string	the type name of table rows

getTableRowTypeOfCurrent()

Gets the type name of table rows that consists of the current row in referenced table.

getTableRowTypeOfCurrent() : string;

Returns

the type name of table rows

setTableRowTypeOfCurrent(string)

Sets the type name of table rows that consists of the current row in referenced table.

setTableRowTypeOfCurrent(name: string) : void;

Parameters:

Parameter	Type	Description
name	string	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.

setBooleanValueString(boolean, string)

Sets the display string value for cell’s boolean value

setBooleanValueString(bv: boolean, name: string) : void;

Parameters:

Parameter	Type	Description
bv	boolean	boolean value
name	string	string value of the boolean 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.

setLocalFunctionName(string, string, boolean)

Sets the locale dependent function name corresponding to given standard function name.

setLocalFunctionName(standardName: string, localName: string, bidirectional: boolean) : void;

Parameters:

Parameter	Type	Description
standardName	string	Standard(en-US locale) function name.
localName	string	Locale dependent function name
bidirectional	boolean	Whether map the local function name to standard function name automatically. /// If true, the local name will be mapped to standard name automatically /// so user does not need to call [SetStandardFunctionName(string, string, bool)](../setstandardfunctionname(string, string, bool)/) again /// for the same standard and local names pair

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.

setStandardFunctionName(string, string, boolean)

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

setStandardFunctionName(localName: string, standardName: string, bidirectional: boolean) : void;

Parameters:

Parameter	Type	Description
localName	string	Locale dependent function name
standardName	string	Standard(en-US locale) function name.
bidirectional	boolean	Whether map the standard function name to local function name automatically. /// If true, the standar name will be mapped to local name automatically /// so user does not need to call [SetLocalFunctionName(string, string, bool)](../setlocalfunctionname(string, string, bool)/) again /// for the same standard and local names pair

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.

setLocalBuiltInName(string, string, boolean)

Sets the locale dependent text for the built-in name with given standard name text.

setLocalBuiltInName(standardName: string, localName: string, bidirectional: boolean) : void;

Parameters:

Parameter	Type	Description
standardName	string	Standard(en-US locale) name text of built-in name.
localName	string	Locale dependent name text
bidirectional	boolean	Whether map the local name text to standard name text automatically. /// If true, the local name text will be mapped to standard name text automatically /// so user does not need to call [SetStandardBuiltInName(string, string, bool)](../setstandardbuiltinname(string, string, bool)/) again /// for the same standard and local names pair

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.

setStandardBuiltInName(string, string, boolean)

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

setStandardBuiltInName(localName: string, standardName: string, bidirectional: boolean) : void;

Parameters:

Parameter	Type	Description
localName	string	Locale dependent function name
standardName	string	Standard(en-US locale) function name.
bidirectional	boolean	Whether map the standard name text to local name text automatically. /// If true, the standar name text will be mapped to local name text automatically /// so user does not need to call [SetLocalBuiltInName(string, string, bool)](../setlocalbuiltinname(string, string, bool)/) again /// for the same standard and local names pair

setListSeparator(string)

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

setListSeparator(c: string) : void;

Parameters:

Parameter	Type	Description
c	string	the specified separator

setRowSeparatorOfFormulaArray(string)

Sets the separator for rows in array data in formula.

setRowSeparatorOfFormulaArray(c: string) : void;

Parameters:

Parameter	Type	Description
c	string	the specified separator

setColumnSeparatorOfFormulaArray(string)

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

setColumnSeparatorOfFormulaArray(c: string) : void;

Parameters:

Parameter	Type	Description
c	string	the specified separator

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)

setStandardHeaderFooterFontStyleName(string, string)

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

setStandardHeaderFooterFontStyleName(localfontStyleName: string, standardName: string) : void;

Parameters:

Parameter	Type	Description
localfontStyleName	string	Locale font style name for Header/Footer.
standardName	string	Standard(en-US locale) function name.

getCommentTitleName(CommentTitleType)

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

getCommentTitleName(type: CommentTitleType) : string;

Parameters:

Parameter	Type	Description
type	CommentTitleType	type of comment title

Returns

locale dependent comment title name

setCommentTitleName(CommentTitleType, string)

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

setCommentTitleName(type: CommentTitleType, name: string) : void;

Parameters:

Parameter	Type	Description
type	CommentTitleType	type of comment title
name	string	locale dependent comment title name

isNull()

Checks whether the implementation object is null.

isNull() : boolean;