asposecells.api

Class GlobalizationSettings

Repsents the globalization settings.

Constructor Summary
 
Property Getters/Setters Summary
methodgetColumnSeparatorOfFormulaArray()
Gets the separator for the items in array's row data in formula.
methodgetListSeparator()
Gets the separator for list, parameters of function, ...etc.
methodgetRowSeparatorOfFormulaArray()
Gets the separator for rows in array data in formula.
 
Method Summary
methodgetAllName()
Gets the name of "(All)" label in the PivotTable.
methodgetBooleanValueString(bv)
Gets the display string value for cell's boolean value
methodgetColumnLablesName()
Gets the name of "Column Labels" label in the PivotTable.
methodgetEmptyDataName()
Gets the name of "(blank)" label in the PivotTable.
methodgetErrorValueString(err)
Gets the display string value for cell's error value
methodgetGrandTotalName(functionType)
Gets the grand total name of the function.
methodgetLocalBuiltInName(standardName)
Gets the locale dependent text for built-in Name according to given standard text.
methodgetLocalFunctionName(standardName)
Gets the locale dependent function name according to given standard function name.
methodgetMultipleItemsName()
Gets the name of "(Multiple Items)" label in the PivotTable.
methodgetOtherName()
Gets the name of "Other" labels for Pie charts.
methodgetPivotGrandTotalName()
Gets the name of "Grand Total" label in the PivotTable.
methodgetPivotTotalName()
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.
methodgetRowLablesName()
Gets the name of "Row Labels" label in the PivotTable.
methodgetStandardBuiltInName(localName)
Gets the standard text of built-in Name according to given locale dependent text.
methodgetStandardFunctionName(localName)
Gets the standard function name according to given locale dependent function name.
methodgetStandardHeaderFooterFontStyleName(localfontStyleName)
Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
methodgetSubTotalName(subTotalType)
Gets the name of PivotFieldSubtotalType type in the PivotTable.
methodgetTableRowTypeOfAll()
Gets the type name of table rows that consists of all rows in referenced table. Default is "All": "#All" denotes all rows in referenced table.
methodgetTableRowTypeOfCurrent()
Gets the type name of table rows that consists of the current row in referenced table. Default is "This Row": "#This Row" denotes the current row in referenced table.
methodgetTableRowTypeOfData()
Gets the type name of table rows that consists of data region of referenced table. Default is "Data": "#Data" denotes the data region of the table.
methodgetTableRowTypeOfHeaders()
Gets the type name of table rows that consists of the table header. Default is "Headers": "#Headers" denotes the table header.
methodgetTableRowTypeOfTotals()
Gets the type name of table rows that consists of the total row of referenced table. Default is "Totals": "#Totals" denotes the total row of referenced table.
methodgetTotalName(functionType)
Gets the total name of the function.
 

    • Constructor Detail

      • GlobalizationSettings

        GlobalizationSettings()
    • Property Getters/Setters Detail

      • getListSeparator : char 

        char getListSeparator()
        
        Gets the separator for list, parameters of function, ...etc.
      • getRowSeparatorOfFormulaArray : char 

        char getRowSeparatorOfFormulaArray()
        
        Gets the separator for rows in array data in formula.
      • getColumnSeparatorOfFormulaArray : char 

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

      • getPivotTotalName

        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

        String getPivotGrandTotalName()
        Gets the name of "Grand Total" label in the PivotTable.
        Returns:
        The name of "Grand Total" label
      • getMultipleItemsName

        String getMultipleItemsName()
        Gets the name of "(Multiple Items)" label in the PivotTable.
        Returns:
        The name of "(Multiple Items)" label
      • getAllName

        String getAllName()
        Gets the name of "(All)" label in the PivotTable.
        Returns:
        The name of "(All)" label
      • getColumnLablesName

        String getColumnLablesName()
        Gets the name of "Column Labels" label in the PivotTable.
        Returns:
        The name of column labels
      • getRowLablesName

        String getRowLablesName()
        Gets the name of "Row Labels" label in the PivotTable.
        Returns:
        The name of row labels
      • getEmptyDataName

        String getEmptyDataName()
        Gets the name of "(blank)" label in the PivotTable.
        Returns:
        The name of empty data
      • getTotalName

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

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

        String getOtherName()
        Gets the name of "Other" labels for Pie charts.
        Returns:
      • getTableRowTypeOfHeaders

        String getTableRowTypeOfHeaders()
        Gets the type name of table rows that consists of the table header. Default is "Headers": "#Headers" denotes the table header.
        Returns:
        the type name of table rows
      • getTableRowTypeOfData

        String getTableRowTypeOfData()
        Gets the type name of table rows that consists of data region of referenced table. Default is "Data": "#Data" denotes the data region of the table.
        Returns:
        the type name of table rows
      • getTableRowTypeOfAll

        String getTableRowTypeOfAll()
        Gets the type name of table rows that consists of all rows in referenced table. Default is "All": "#All" denotes all rows in referenced table.
        Returns:
        the type name of table rows
      • getTableRowTypeOfTotals

        String getTableRowTypeOfTotals()
        Gets the type name of table rows that consists of the total row of referenced table. Default is "Totals": "#Totals" denotes the total row of referenced table.
        Returns:
        the type name of table rows
      • getTableRowTypeOfCurrent

        String getTableRowTypeOfCurrent()
        Gets the type name of table rows that consists of the current row in referenced table. Default is "This Row": "#This Row" denotes the current row in referenced table.
        Returns:
        the type name of table rows
      • getErrorValueString

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

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

        String getLocalFunctionName(standardName)
        Gets the locale dependent function name according to given standard function name.
        Parameters:
        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 getStandardFunctionName(localName)
        Gets the standard function name according to given locale dependent function name.
        Parameters:
        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 getLocalBuiltInName(standardName)
        Gets the locale dependent text for built-in Name according to given standard text.
        Parameters:
        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 getStandardBuiltInName(localName)
        Gets the standard text of built-in Name according to given locale dependent text.
        Parameters:
        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 getStandardHeaderFooterFontStyleName(localfontStyleName)
        Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
        Parameters:
        localfontStyleName: String - Locale font style name for Header/Footer.
        Returns:
        Standard English font style name(Regular, Bold, Italic)