GlobalizationSettings
GlobalizationSettings class
Represents the globalization settings.
Constructors
| Name | Description |
|---|---|
| GlobalizationSettings |
Properties
| Name | Type | Description |
|---|---|---|
| ChartSettings | ChartGlobalizationSettings | Gets or sets the globalization settings for Chart. |
| PivotSettings | PivotGlobalizationSettings | Gets or sets the globalization settings for pivot table. |
| 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. |
Methods
| Name | Description |
|---|---|
| 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 | | getTotalName | Gets the total name of the function. | | getGrandTotalName | Gets the grand total name of the function. | | getDefaultSheetName | Gets the default sheet name for adding worksheet automatically. Default is “Sheet”.
The automatically added(such as by | | getTableRowTypeOfHeaders | Gets the type name of table rows that consists of the table header. Default is “Headers”, so in formula “#Headers” repre | | getTableRowTypeOfData | Gets the type name of table rows that consists of data region of referenced table. Default is “Data”, so in formula “#Da | | getTableRowTypeOfAll | Gets the type name of table rows that consists of all rows in referenced table. Default is “All”, so in formula “#All” r | | getTableRowTypeOfTotals | Gets the type name of table rows that consists of the total row of referenced table. Default is “Totals”, so in formula | | getTableRowTypeOfCurrent | Gets the type name of table rows that consists of the current row in referenced table. Default is “This Row”, so in form | | getErrorValueString | Gets the display string value for cell’s error value | | getBooleanValueString | Gets the display string value for cell’s boolean value | | getLocalFunctionName | Gets the locale dependent function name according to given standard function name. | | getStandardFunctionName | Gets the standard function name according to given locale dependent function name. | | getLocalBuiltInName | Gets the locale dependent text for built-in Name according to given standard text. | | getStandardBuiltInName | Gets the standard text of built-in Name according to given locale dependent text. | | getStandardHeaderFooterFontStyleName | Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name | | getCommentTitleName | Gets the locale dependent comment title name according to comment title type. | | compare | Compares two string values according to certain collation rules. | | getCollationKey | Transforms the string into a comparable object according to certain collation rules. |
GlobalizationSettings()
GlobalizationSettings.ChartSettings property
Gets or sets the globalization settings for Chart.
Type: ChartGlobalizationSettings
GlobalizationSettings.PivotSettings property
Gets or sets the globalization settings for pivot table.
Type: PivotGlobalizationSettings
GlobalizationSettings.ListSeparator property
Gets the separator for list, parameters of function, …etc.
Type: char
GlobalizationSettings.RowSeparatorOfFormulaArray property
Gets the separator for rows in array data in formula.
Type: char
GlobalizationSettings.ColumnSeparatorOfFormulaArray property
Gets the separator for the items in array’s row data in formula.
Type: char
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
getTotalName(functionType)
Gets the total name of the function.
| Parameter | Type | Description |
|---|---|---|
| functionType | int | A ConsolidationFunction value. The function type. |
Returns: 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.
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
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
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
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.
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.
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.
Returns: 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.
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.
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.
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.
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.
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)
getCommentTitleName(type)
Gets the locale dependent comment title name according to comment title type.
| Parameter | Type | Description |
|---|---|---|
| type | int | A CommentTitleType value. |
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