aspose.cells

Class GlobalizationSettings

Represents the globalization settings.

Constructor Summary
 
Property Getters/Setters Summary
functiongetChartSettings()
function
           Gets or sets the globalization settings for Chart.
functiongetColumnSeparatorOfFormulaArray()
Gets the separator for the items in array's row data in formula.
functiongetListSeparator()
Gets the separator for list, parameters of function, ...etc.
functiongetPivotSettings()
function
           Gets or sets the globalization settings for pivot table.
functiongetRowSeparatorOfFormulaArray()
Gets the separator for rows in array data in formula.
 
Method Summary
functioncompare(v1, v2, ignoreCase)
Compares two string values according to certain collation rules.
functiongetAllName()
Gets the name of "(All)" label in the PivotTable.
functiongetBooleanValueString(bv)
Gets the display string value for cell's boolean value
functiongetCollationKey(v, ignoreCase)
Transforms the string into a comparable object according to certain collation rules.
functiongetColumnLabelsOfPivotTable()
Gets the name of "Column Labels" label in the PivotTable.
functiongetCommentTitleName(type)
Gets the locale dependent comment title name according to comment title type.
functiongetDataFieldHeaderNameOfPivotTable()
Gets the the name of the value area field header in the PivotTable.
functiongetDefaultSheetName()
Gets the default sheet name for adding worksheet automatically. Default is "Sheet".
functiongetEmptyDataName()
Gets the name of "(blank)" label in the PivotTable.
functiongetErrorValueString(err)
Gets the display string value for cell's error value
functiongetGrandTotalName(functionType)
Gets the grand total name of the function.
functiongetLocalBuiltInName(standardName)
Gets the locale dependent text for built-in Name according to given standard text.
functiongetLocalFunctionName(standardName)
Gets the locale dependent function name according to given standard function name.
functiongetMultipleItemsName()
Gets the name of "(Multiple Items)" label in the PivotTable.
functiongetPivotGrandTotalName()
Gets the name of "Grand Total" label in the PivotTable.
functiongetPivotTotalName()
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.
functiongetProtectionNameOfPivotTable()
Gets the protection name in the PivotTable.
functiongetRowLabelsNameOfPivotTable()
Gets the name of "Row Labels" label in the PivotTable.
functiongetStandardBuiltInName(localName)
Gets the standard text of built-in Name according to given locale dependent text.
functiongetStandardFunctionName(localName)
Gets the standard function name according to given locale dependent function name.
functiongetStandardHeaderFooterFontStyleName(localfontStyleName)
Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
functiongetSubTotalName(subTotalType)
Gets the name of PivotFieldSubtotalType type in the PivotTable.
functiongetTableRowTypeOfAll()
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.
functiongetTableRowTypeOfCurrent()
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.
functiongetTableRowTypeOfData()
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.
functiongetTableRowTypeOfHeaders()
Gets the type name of table rows that consists of the table header. Default is "Headers", so in formula "#Headers" represents the table header.
functiongetTableRowTypeOfTotals()
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.
functiongetTotalName(functionType)
Gets the total name of the function.
 

    • Constructor Detail

      • GlobalizationSettings

        function GlobalizationSettings()
    • Property Getters/Setters Detail

      • getChartSettings/setChartSettings : ChartGlobalizationSettings 

        function getChartSettings() / function setChartSettings(value)
        
        Gets or sets the globalization settings for Chart.
      • getPivotSettings/setPivotSettings : PivotGlobalizationSettings 

        function getPivotSettings() / function setPivotSettings(value)
        
        Gets or sets the globalization settings for pivot table.
      • getListSeparator : char 

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

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

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

      • getPivotTotalName

        function 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

        function 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

        function 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

        function 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

        function 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

        function 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

        function 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

        function 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

        function 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

        function 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.
        Parameters:
        subTotalType: Number - A PivotFieldSubtotalType value. The PivotFieldSubtotalType type
        Returns:
        The name of PivotFieldSubtotalType type
      • getTotalName

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

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

        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

        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
      • getTableRowTypeOfData

        function 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

        function 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

        function 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

        function 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

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

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

        function 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

        function 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

        function 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

        function 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

        function 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)
      • getCommentTitleName

        function getCommentTitleName(type)
        Gets the locale dependent comment title name according to comment title type.
        Parameters:
        type: Number - A CommentTitleType value.
        Returns:
      • compare

        function compare(v1, v2, ignoreCase)
        Compares two string values according to certain collation rules.
        Parameters:
        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

        function getCollationKey(v, ignoreCase)
        Transforms the string into a comparable object according to certain collation rules.
        Parameters:
        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