Class GlobalizationSettings

Class GlobalizationSettings

Namespace: Aspose.Cells
Assembly: Aspose.Cells.dll (25.2.0)

Represents the globalization settings.

public class GlobalizationSettings

Inheritance

objectGlobalizationSettings

Derived

SettableGlobalizationSettings

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

GlobalizationSettings()

public GlobalizationSettings()

Properties

ChartSettings

Gets or sets the globalization settings for Chart.

public ChartGlobalizationSettings ChartSettings { get; set; }

Property Value

ChartGlobalizationSettings

ColumnSeparatorOfFormulaArray

Gets the separator for the items in array’s row data in formula.

public virtual char ColumnSeparatorOfFormulaArray { get; }

Property Value

char

ListSeparator

Gets the separator for list, parameters of function, …etc.

public virtual char ListSeparator { get; }

Property Value

char

PivotSettings

Gets or sets the globalization settings for pivot table.

public PivotGlobalizationSettings PivotSettings { get; set; }

Property Value

PivotGlobalizationSettings

RowSeparatorOfFormulaArray

Gets the separator for rows in array data in formula.

public virtual char RowSeparatorOfFormulaArray { get; }

Property Value

char

Methods

Compare(string, string, bool)

Compares two string values according to certain collation rules.

public virtual int Compare(string v1, string v2, bool ignoreCase)

Parameters

v1 string

the first string

v2 string

the second string

ignoreCase bool

whether ignore case when comparing values

Returns

int

Integer that indicates the lexical relationship between the two comparands

GetAllName()

Gets the name of “(All)” label in the PivotTable.

[Obsolete("Use PivotGlobalizationSettings.GetTextOfAll() method instead.")]
public virtual string GetAllName()

Returns

string

The name of “(All)” label

Remarks

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.

GetBooleanValueString(bool)

Gets the display string value for cell’s boolean value

public virtual string GetBooleanValueString(bool bv)

Parameters

bv bool

boolean value

Returns

string

By default returns “TRUE” for true value and “FALSE” for false value.

GetCollationKey(string, bool)

Transforms the string into a comparable object according to certain collation rules.

public virtual IComparable GetCollationKey(string v, bool ignoreCase)

Parameters

v string

String value needs to be compared with others.

ignoreCase bool

whether ignore case when comparing values

Returns

IComparable

Object can be used to compare or sort string values

GetColumnLabelsOfPivotTable()

Gets the name of “Column Labels” label in the PivotTable.

[Obsolete("Use PivotGlobalizationSettings.GetTextOfColumnLabels() method instead.")]
public virtual string GetColumnLabelsOfPivotTable()

Returns

string

The name of column labels

Remarks

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.

GetCommentTitleName(CommentTitleType)

Gets the locale dependent comment title name according to comment title type.

public virtual string GetCommentTitleName(CommentTitleType type)

Parameters

type CommentTitleType

Returns

string

GetDataFieldHeaderNameOfPivotTable()

Gets the the name of the value area field header in the PivotTable.

[Obsolete("Use PivotGlobalizationSettings.GetTextOfDataFieldHeader() method instead.")]
public virtual string GetDataFieldHeaderNameOfPivotTable()

Returns

string

The name of data field header name

Remarks

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.

GetDefaultSheetName()

Gets the default sheet name for adding worksheet automatically. Default is “Sheet”.

public virtual string GetDefaultSheetName()

Returns

string

the default sheet name for adding worksheet automatically

Remarks

The automatically added(such as by Aspose.Cells.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”.

GetEmptyDataName()

Gets the name of “(blank)” label in the PivotTable.

[Obsolete("Use PivotGlobalizationSettings.GetTextOfEmptyData() method instead.")]
public virtual string GetEmptyDataName()

Returns

string

The name of empty data

Remarks

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.

GetErrorValueString(string)

Gets the display string value for cell’s error value

public virtual string GetErrorValueString(string err)

Parameters

err string

error values such as #VALUE!,#NAME?

Returns

string

By default returns the error value itself

GetGrandTotalName(ConsolidationFunction)

Gets the grand total name of the function.

public virtual string GetGrandTotalName(ConsolidationFunction functionType)

Parameters

functionType ConsolidationFunction

The function type.

Returns

string

The grand total name of the function.

GetLocalBuiltInName(string)

Gets the locale dependent text for built-in Name according to given standard text.

public virtual string GetLocalBuiltInName(string standardName)

Parameters

standardName string

Standard(en-US locale) text of built-in Name.

Returns

string

Locale dependent text. The locale was specified by the Workbook for which this settings is used.

GetLocalFunctionName(string)

Gets the locale dependent function name according to given standard function name.

public virtual string GetLocalFunctionName(string standardName)

Parameters

standardName string

Standard(en-US locale) function name.

Returns

string

Locale dependent function name. The locale was specified by the Workbook for which this settings is used.

GetMultipleItemsName()

Gets the name of “(Multiple Items)” label in the PivotTable.

[Obsolete("Use PivotGlobalizationSettings.GetTextOfMultipleItems() method instead.")]
public virtual string GetMultipleItemsName()

Returns

string

The name of “(Multiple Items)” label

Remarks

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.

GetRowLabelsNameOfPivotTable()

Gets the name of “Row Labels” label in the PivotTable.

[Obsolete("Use PivotGlobalizationSettings.GetTextOfRowLabels() method instead.")]
public virtual string GetRowLabelsNameOfPivotTable()

Returns

string

The name of row labels

Remarks

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.

GetStandardBuiltInName(string)

Gets the standard text of built-in Name according to given locale dependent text.

public virtual string GetStandardBuiltInName(string localName)

Parameters

localName string

Locale dependent text of built-in Name. The locale was specified by the Workbook for which this settings is used.

Returns

string

Standard(en-US locale) text.

GetStandardFunctionName(string)

Gets the standard function name according to given locale dependent function name.

public virtual string GetStandardFunctionName(string localName)

Parameters

localName string

Locale dependent function name. The locale was specified by the Workbook for which this settings is used.

Returns

string

Standard(en-US locale) function name.

GetStandardHeaderFooterFontStyleName(string)

Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.

public virtual string GetStandardHeaderFooterFontStyleName(string localfontStyleName)

Parameters

localfontStyleName string

Locale font style name for Header/Footer.

Returns

string

Standard English font style name(Regular, Bold, Italic)

GetSubTotalName(PivotFieldSubtotalType)

Gets the name of Aspose.Cells.Pivot.PivotFieldSubtotalType type in the PivotTable.

[Obsolete("Use PivotGlobalizationSettings.GetTextOfSubTotal() method instead.")]
public virtual string GetSubTotalName(PivotFieldSubtotalType subTotalType)

Parameters

subTotalType PivotFieldSubtotalType

The Aspose.Cells.Pivot.PivotFieldSubtotalType type

Returns

string

The name of Aspose.Cells.Pivot.PivotFieldSubtotalType type

Remarks

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.

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.

public virtual string GetTableRowTypeOfAll()

Returns

string

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.

public virtual string GetTableRowTypeOfCurrent()

Returns

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.

public virtual string GetTableRowTypeOfData()

Returns

string

the type name of table rows

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.

public virtual string GetTableRowTypeOfHeaders()

Returns

string

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.

public virtual string GetTableRowTypeOfTotals()

Returns

string

the type name of table rows

GetTotalName(ConsolidationFunction)

Gets the total name of the function.

public virtual string GetTotalName(ConsolidationFunction functionType)

Parameters

functionType ConsolidationFunction

The function type.

Returns

string

The total name of the function.