SettableGlobalizationSettings
SettableGlobalizationSettings class
Implementation of GlobalizationSettings that supports user to set/change pre-defined texts.
Constructors
| Name | Description |
|---|---|
| SettableGlobalizationSettings |
Properties
| Name | Type | Description |
|---|---|---|
| ListSeparator | char | Gets the separator for list, parameters of function, …etc. |
| RowSeparatorOfFormulaArray | char | Gets the separator for rows in array data in formula. |
| ColumnSeparatorOfFormulaArray | char | Gets the separator for the items in array’s row data in formula. |
| ChartSettings | ChartGlobalizationSettings | Gets or sets the globalization settings for Chart. |
| PivotSettings | PivotGlobalizationSettings | Gets or sets the globalization settings for pivot table. |
Methods
| Name | Description |
|---|---|
| getTotalName | Gets the total name of specific function. |
| setTotalName | Sets the total name of specific function. |
| getGrandTotalName | Gets the grand total name of the function. |
| setGrandTotalName | 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” repre |
| setTableRowTypeOfHeaders | 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 “#Da |
| setTableRowTypeOfData | 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 | 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 | 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 | Sets the type name of table rows that consists of the current row in referenced table. |
| getErrorValueString | Gets the display string value for cell’s error value |
| getBooleanValueString | Gets the display string value for cell’s boolean value |
| setBooleanValueString | Sets the display string value for cell’s boolean value |
| getLocalFunctionName | Gets the locale dependent function name according to given standard function name. |
| setLocalFunctionName | Sets the locale dependent function name corresponding to given standard function name. |
| getStandardFunctionName | Gets the standard function name according to given locale dependent function name. |
| setStandardFunctionName | Sets the locale dependent function name according to given standard function name. |
| getLocalBuiltInName | Gets the locale dependent text for built-in Name according to given standard text. |
| setLocalBuiltInName | Sets the locale dependent text for the built-in name with given standard name text. |
| getStandardBuiltInName | Gets the standard text of built-in Name according to given locale dependent text. |
| setStandardBuiltInName | Sets the locale dependent function name according to given standard function name. |
| setListSeparator | Sets the separator for list, parameters of function, …etc. |
| setRowSeparatorOfFormulaArray | Sets the separator for rows in array data in formula. |
| setColumnSeparatorOfFormulaArray | Sets the separator for the items in array’s row data in formula. |
| getStandardHeaderFooterFontStyleName | Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name |
| setStandardHeaderFooterFontStyleName | Sets the locale dependent function name according to given standard function name. |
| getCommentTitleName | Gets the locale dependent comment title name according to comment title type. |
| setCommentTitleName | Gets the locale dependent comment title name according to comment title type. |
| getPivotTotalName | Gets the name of “Total” label in the PivotTable. You need to override this method when the PivotTable contains two or m |
| getPivotGrandTotalName | Gets the name of “Grand Total” label in the PivotTable. |
NOTE: This member is now obsolete. Instead, please use PivotGlo | | getMultipleItemsName | Gets the name of “(Multiple Items)” label in the PivotTable.
NOTE: This member is now obsolete. Instead, please use Piv | | getAllName | Gets the name of “(All)” label in the PivotTable.
NOTE: This member is now obsolete. Instead, please use GlobalizationS | | getProtectionNameOfPivotTable | Gets the protection name in the PivotTable.
NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSe | | getColumnLabelsOfPivotTable | Gets the name of “Column Labels” label in the PivotTable.
NOTE: This member is now obsolete. Instead, please use PivotG | | getRowLabelsNameOfPivotTable | Gets the name of “Row Labels” label in the PivotTable.
NOTE: This member is now obsolete. Instead, please use PivotGlob | | getEmptyDataName | Gets the name of “(blank)” label in the PivotTable.
NOTE: This member is now obsolete. Instead, please use PivotGlobali | | getDataFieldHeaderNameOfPivotTable | Gets the the name of the value area field header in the PivotTable.
NOTE: This member is now obsolete. Instead, please | | getSubTotalName | Gets the name of PivotFieldSubtotalType type in the PivotTable.
NOTE: This member is now obsolete. Instead, please use | | getDefaultSheetName | Gets the default sheet name for adding worksheet automatically. Default is “Sheet”.
The automatically added(such as by | | compare | Compares two string values according to certain collation rules. | | getCollationKey | Transforms the string into a comparable object according to certain collation rules. |
SettableGlobalizationSettings()
SettableGlobalizationSettings.ListSeparator property
Gets the separator for list, parameters of function, …etc.
Type: char
SettableGlobalizationSettings.RowSeparatorOfFormulaArray property
Gets the separator for rows in array data in formula.
Type: char
SettableGlobalizationSettings.ColumnSeparatorOfFormulaArray property
Gets the separator for the items in array’s row data in formula.
Type: char
SettableGlobalizationSettings.ChartSettings property
Gets or sets the globalization settings for Chart.
Type: ChartGlobalizationSettings
SettableGlobalizationSettings.PivotSettings property
Gets or sets the globalization settings for pivot table.
Type: PivotGlobalizationSettings
getTotalName(functionType)
Gets the total name of specific function.
| Parameter | Type | Description |
|---|---|---|
| functionType | int | A ConsolidationFunction value. The function type. |
Returns: The total name of the function.
setTotalName(functionType, name)
Sets the total name of specific function.
| Parameter | Type | Description |
|---|---|---|
| functionType | int | A ConsolidationFunction value. The function type. |
| name | String | The total name of the function. |
getGrandTotalName(functionType)
Gets the grand total name of the function.
| Parameter | Type | Description |
|---|---|---|
| functionType | int | A ConsolidationFunction value. The function type. |
Returns: The grand total name of the function.
setGrandTotalName(functionType, name)
Sets the grand total name of specific function.
| Parameter | Type | Description |
|---|---|---|
| functionType | int | A ConsolidationFunction value. 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.
Returns: the type name of table rows
setTableRowTypeOfHeaders(name)
Sets the type name of table rows that consists of the table header.
| 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.
Returns: the type name of table rows
setTableRowTypeOfData(name)
Sets the type name of table rows that consists of data region of referenced table.
| 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.
Returns: the type name of table rows
setTableRowTypeOfAll(name)
Sets the type name of table rows that consists of all rows in referenced table.
| 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.
Returns: the type name of table rows
setTableRowTypeOfTotals(name)
Sets the type name of table rows that consists of the total row of referenced table.
| 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.
Returns: the type name of table rows
setTableRowTypeOfCurrent(name)
Sets the type name of table rows that consists of the current row in referenced table.
| Parameter | Type | Description |
|---|---|---|
| name | String | the type name of table rows |
getErrorValueString(err)
Gets the display string value for cell’s error value
| Parameter | Type | Description |
|---|---|---|
| err | String | error values such as #VALUE!,#NAME? |
Returns: By default returns the error value itself
getBooleanValueString(bv)
Gets the display string value for cell’s boolean value
| Parameter | Type | Description |
|---|---|---|
| bv | boolean | boolean value |
Returns: By default returns “TRUE” for true value and “FALSE” for false value.
setBooleanValueString(bv, name)
Sets the display string value for cell’s boolean value
| Parameter | Type | Description |
|---|---|---|
| bv | boolean | boolean value |
| name | String | string value of the boolean value |
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: Locale dependent function name. The locale was specified by the Workbook for which this settings is used.
setLocalFunctionName(standardName, localName, bidirectional)
Sets the locale dependent function name corresponding to given standard function name.
| 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(java.lang.String, java.lang.String, boolean) again for the same standard and local names pair |
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: Standard(en-US locale) function name.
setStandardFunctionName(localName, standardName, bidirectional)
Sets the locale dependent function name according to given standard function name.
| 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(java.lang.String, java.lang.String, boolean) again for the same standard and local names pair |
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: Locale dependent text. The locale was specified by the Workbook for which this settings is used.
setLocalBuiltInName(standardName, localName, bidirectional)
Sets the locale dependent text for the built-in name with given standard name text.
| 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(java.lang.String, java.lang.String, boolean) again for the same standard and local names pair |
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: Standard(en-US locale) text.
setStandardBuiltInName(localName, standardName, bidirectional)
Sets the locale dependent function name according to given standard function name.
| 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(java.lang.String, java.lang.String, boolean) again for the same standard and local names pair |
setListSeparator(c)
Sets the separator for list, parameters of function, …etc.
| Parameter | Type | Description |
|---|---|---|
| c | char | the specified separator |
setRowSeparatorOfFormulaArray(c)
Sets the separator for rows in array data in formula.
| Parameter | Type | Description |
|---|---|---|
| c | char | the specified separator |
setColumnSeparatorOfFormulaArray(c)
Sets the separator for the items in array’s row data in formula.
| Parameter | Type | Description |
|---|---|---|
| c | char | the specified separator |
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: Standard English font style name(Regular, Bold, Italic)
setStandardHeaderFooterFontStyleName(localfontStyleName, standardName)
Sets the locale dependent function name according to given standard function name.
| Parameter | Type | Description |
|---|---|---|
| localfontStyleName | String | Locale font style name for Header/Footer. |
| standardName | String | Standard(en-US locale) function name. |
getCommentTitleName(type)
Gets the locale dependent comment title name according to comment title type.
| Parameter | Type | Description |
|---|---|---|
| type | int | A CommentTitleType value. type of comment title |
Returns: locale dependent comment title name
setCommentTitleName(type, name)
Gets the locale dependent comment title name according to comment title type.
| Parameter | Type | Description |
|---|---|---|
| type | int | A CommentTitleType value. type of comment title |
| name | String | locale dependent comment title name |
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.
Returns: The name of “Total” 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.
Returns: The name of “Grand Total” label
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.
Returns: The name of “(Multiple Items)” label
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.
Returns: The name of “(All)” 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.
Returns: The protection name of PivotTable
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.
Returns: The name of column labels
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.
Returns: The name of row labels
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.
Returns: The name of empty data
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.
Returns: The name of data field header name
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 | int | A PivotFieldSubtotalType value. The PivotFieldSubtotalType type |
Returns: The name of PivotFieldSubtotalType type
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”.
Returns: the default sheet name for adding worksheet automatically
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: Integer that indicates the lexical relationship between the two comparands
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: Object can be used to compare or sort string values