com.aspose.cells
Class GlobalizationSettings

java.lang.Object
  extended by AbstractGlobalizationSettings
      extended by com.aspose.cells.GlobalizationSettings

public class GlobalizationSettings 
extends AbstractGlobalizationSettings

Represents the globalization settings.


Constructor Summary
GlobalizationSettings()
          
 
Property Getters/Setters Summary
ChartGlobalizationSettingsgetChartSettings()
voidsetChartSettings(ChartGlobalizationSettings)
           Gets or sets the Chart of thisChartGlobalizationSettings
chargetColumnSeparatorOfFormulaArray()
           Gets the separator for the items in array's row data in formula.
chargetListSeparator()
           Gets the separator for list, parameters of function, ...etc.
chargetRowSeparatorOfFormulaArray()
           Gets the separator for rows in array data in formula.
 
Method Summary
intcompare(java.lang.String v1, java.lang.String v2, boolean ignoreCase)→ inherited from AbstractGlobalizationSettings
           Compares two string values according to certain collation rules.
java.lang.StringgetAllName()
           Gets the name of "(All)" label in the PivotTable.
java.lang.StringgetBooleanValueString(boolean bv)
           Gets the display string value for cell's boolean value
System.IComparablegetCollationKey(java.lang.String v, boolean ignoreCase)→ inherited from AbstractGlobalizationSettings
           Transforms the string into a comparable object according to certain collation rules.
java.lang.StringgetColumnLabelsOfPivotTable()
           Gets the name of "Column Labels" label in the PivotTable.
java.lang.StringgetColumnLablesName()
           Gets the name of "Column Labels" label in the PivotTable.
java.lang.StringgetCommentTitleName(int type)
           Gets the locale dependent comment title name according to comment title type.
java.lang.StringgetEmptyDataName()
           Gets the name of "(blank)" label in the PivotTable.
java.lang.StringgetErrorValueString(java.lang.String err)
           Gets the display string value for cell's error value
java.lang.StringgetGrandTotalName(int functionType)
           Gets the grand total name of the function.
java.lang.StringgetLocalBuiltInName(java.lang.String standardName)
           Gets the locale dependent text for built-in Name according to given standard text.
java.lang.StringgetLocalFunctionName(java.lang.String standardName)
           Gets the locale dependent function name according to given standard function name.
java.lang.StringgetMultipleItemsName()
           Gets the name of "(Multiple Items)" label in the PivotTable.
java.lang.StringgetOtherName()
           Gets the name of "Other" labels for Pie charts.
java.lang.StringgetPivotGrandTotalName()
           Gets the name of "Grand Total" label in the PivotTable.
java.lang.StringgetPivotTotalName()
           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.
java.lang.StringgetProtectionNameOfPivotTable()
           Gets the protection name in the PivotTable.
java.lang.StringgetRowLabelsNameOfPivotTable()
           Gets the name of "Row Labels" label in the PivotTable.
java.lang.StringgetRowLablesName()
           Gets the name of "Row Labels" label in the PivotTable.
java.lang.StringgetStandardBuiltInName(java.lang.String localName)
           Gets the standard text of built-in Name according to given locale dependent text.
java.lang.StringgetStandardFunctionName(java.lang.String localName)
           Gets the standard function name according to given locale dependent function name.
java.lang.StringgetStandardHeaderFooterFontStyleName(java.lang.String localfontStyleName)
           Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
java.lang.StringgetSubTotalName(int subTotalType)
           Gets the name of PivotFieldSubtotalType type in the PivotTable.
java.lang.StringgetTableRowTypeOfAll()
           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.
java.lang.StringgetTableRowTypeOfCurrent()
           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.
java.lang.StringgetTableRowTypeOfData()
           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.
java.lang.StringgetTableRowTypeOfHeaders()
           Gets the type name of table rows that consists of the table header. Default is "Headers", so in formula "#Headers" represents the table header.
java.lang.StringgetTableRowTypeOfTotals()
           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.
java.lang.StringgetTotalName(int functionType)
           Gets the total name of the function.
 

Constructor Detail

GlobalizationSettings

public GlobalizationSettings()

Property Getters/Setters Detail

getChartSettings/setChartSettings

public ChartGlobalizationSettings getChartSettings() / public void setChartSettings(ChartGlobalizationSettings value)
Gets or sets the Chart of thisChartGlobalizationSettings

setChartSettings

public void setChartSettings(ChartGlobalizationSettings value)
Gets or sets the Chart of thisChartGlobalizationSettings

getListSeparator

public char getListSeparator()
Gets the separator for list, parameters of function, ...etc.

getRowSeparatorOfFormulaArray

public char getRowSeparatorOfFormulaArray()
Gets the separator for rows in array data in formula.

getColumnSeparatorOfFormulaArray

public char getColumnSeparatorOfFormulaArray()
Gets the separator for the items in array's row data in formula.

Method Detail

getPivotTotalName

public java.lang.String 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.
Returns:
The name of "Total" label

getPivotGrandTotalName

public java.lang.String getPivotGrandTotalName()
Gets the name of "Grand Total" label in the PivotTable.
Returns:
The name of "Grand Total" label

getMultipleItemsName

public java.lang.String getMultipleItemsName()
Gets the name of "(Multiple Items)" label in the PivotTable.
Returns:
The name of "(Multiple Items)" label

getAllName

public java.lang.String getAllName()
Gets the name of "(All)" label in the PivotTable.
Returns:
The name of "(All)" label

getColumnLablesName

public java.lang.String getColumnLablesName()
Gets the name of "Column Labels" 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 September 2020. Aspose apologizes for any inconvenience you may have experienced.
Returns:
The name of column labels

getRowLablesName

public java.lang.String getRowLablesName()
Gets the name of "Row Labels" label in the PivotTable. NOTE: This member is now obsolete. Instead, please use GlobalizationSettings.GetRowLabelsOfPivotTable() method. This property will be removed 12 months later since September 2020. Aspose apologizes for any inconvenience you may have experienced.
Returns:
The name of row labels

getProtectionNameOfPivotTable

public java.lang.String getProtectionNameOfPivotTable()
Gets the protection name in the PivotTable.
Returns:
The protection name of PivotTable

getColumnLabelsOfPivotTable

public java.lang.String getColumnLabelsOfPivotTable()
Gets the name of "Column Labels" label in the PivotTable.
Returns:
The name of column labels

getRowLabelsNameOfPivotTable

public java.lang.String getRowLabelsNameOfPivotTable()
Gets the name of "Row Labels" label in the PivotTable.
Returns:
The name of row labels

getEmptyDataName

public java.lang.String getEmptyDataName()
Gets the name of "(blank)" label in the PivotTable.
Returns:
The name of empty data

getSubTotalName

public java.lang.String getSubTotalName(int subTotalType)
Gets the name of PivotFieldSubtotalType type in the PivotTable.
Parameters:
subTotalType - A PivotFieldSubtotalType value. The PivotFieldSubtotalType type
Returns:
The name of PivotFieldSubtotalType type

getTotalName

public java.lang.String getTotalName(int functionType)
Gets the total name of the function.
Parameters:
functionType - A ConsolidationFunction value. The function type.
Returns:
The total name of the function.

getGrandTotalName

public java.lang.String getGrandTotalName(int functionType)
Gets the grand total name of the function.
Parameters:
functionType - A ConsolidationFunction value. The function type.
Returns:
The grand total name of the function.

getOtherName

public java.lang.String getOtherName()
Gets the name of "Other" labels for Pie charts.
Returns:

getTableRowTypeOfHeaders

public java.lang.String 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

public java.lang.String 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

public java.lang.String 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

public java.lang.String 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

public java.lang.String 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

public java.lang.String getErrorValueString(java.lang.String err)
Gets the display string value for cell's error value
Parameters:
err - error values such as #VALUE!,#NAME?
Returns:
Default returns the error value itself

getBooleanValueString

public java.lang.String getBooleanValueString(boolean bv)
Gets the display string value for cell's boolean value
Parameters:
bv - boolean value
Returns:
Default returns "TRUE" for true value and "FALSE" for false value.

getLocalFunctionName

public java.lang.String getLocalFunctionName(java.lang.String standardName)
Gets the locale dependent function name according to given standard function name.
Parameters:
standardName - 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

public java.lang.String getStandardFunctionName(java.lang.String localName)
Gets the standard function name according to given locale dependent function name.
Parameters:
localName - 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

public java.lang.String getLocalBuiltInName(java.lang.String standardName)
Gets the locale dependent text for built-in Name according to given standard text.
Parameters:
standardName - 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

public java.lang.String getStandardBuiltInName(java.lang.String localName)
Gets the standard text of built-in Name according to given locale dependent text.
Parameters:
localName - 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

public java.lang.String getStandardHeaderFooterFontStyleName(java.lang.String localfontStyleName)
Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
Parameters:
localfontStyleName - Locale font style name for Header/Footer.
Returns:
Standard English font style name(Regular, Bold, Italic)

getCommentTitleName

public java.lang.String getCommentTitleName(int type)
Gets the locale dependent comment title name according to comment title type.
Parameters:
type - A CommentTitleType value.
Returns:

compare

→ inherited from AbstractGlobalizationSettings
public int compare(java.lang.String v1, java.lang.String v2, boolean ignoreCase)
Compares two string values according to certain collation rules.
Parameters:
v1 - the first string
v2 - the second string
ignoreCase - whether ignore case when comparing values
Returns:
Integer that indicates the lexical relationship between the two comparands

getCollationKey

→ inherited from AbstractGlobalizationSettings
public System.IComparable getCollationKey(java.lang.String v, boolean ignoreCase)
Transforms the string into a comparable object according to certain collation rules.
Parameters:
v - String value needs to be compared with others.
ignoreCase - whether ignore case when comparing values
Returns:
Object can be used to compare or sort string values

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.