DataItemNumericFormat.FormatType Property

Gets or sets the format type for numeric values.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v18.2.Core.dll

Declaration

C#

public DataItemNumericFormatType FormatType { get; set; }

VB.NET

Public Property FormatType As DataItemNumericFormatType

Property Value

Type	Description
DataItemNumericFormatType	A DataItemNumericFormatType enumeration member that specifies the format type for numeric values.

Available values:

Name	Description
Auto	Format type is defined automatically, according to the data type and summary function (for measures).
General	The most compact of either fixed-point or scientific notation. Ignores the DataItemNumericFormat.Precision value.
Number	Integral and decimal digits, group separators, and a decimal separator with an optional negative sign. 1234.567 -> 1,234.57 (en-US)
Currency	Currency formatting. 123.456 -> $123.46 (en-US)
Scientific	Exponential notation. 1052.0329112756 -> 1.052033E+003 (en-US)
Percent	Number multiplied by 100 and displayed with a percent symbol. -0.39678 -> -39.7 % (en-US)

Remarks

Use the FormatType property to specify whether to format numeric values using a currency, scientific, percentage, numeric or other pattern.

When displaying currency values, use the DataItemNumericFormat.CurrencyCultureName property to specify the actual currency.

Actual format patterns are defined by the current system locale (or the client’s locale, when a dashboard is shown on the web).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FormatType property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winviewer-how-to-create-custom-card-layout-template/CS/ViewerForm.cs#L29

Measure actualValue = new Measure("Sales");
actualValue.NumericFormat.FormatType = DataItemNumericFormatType.Currency;
Measure targetValue = new Measure("SalesTarget");

wpf-dashboard-viewer-item-tabs/CS/WpfDashboardTabSupportExample/WpfDashboardTabSupportExample/DashboardItemGenerator.cs#L15

Measure actualValue = new Measure("Sales");
actualValue.NumericFormat.FormatType = DataItemNumericFormatType.Currency;
Measure targetValue = new Measure("SalesTarget");

winforms-dashboard-viewer-item-tabs/CS/TabSupportExample/DashboardItemGenerator.cs#L20

Measure actualValue = new Measure("Sales");
actualValue.NumericFormat.FormatType = DataItemNumericFormatType.Currency;
Measure targetValue = new Measure("SalesTarget");

VB.NET

winviewer-how-to-create-custom-card-layout-template/VB/ViewerForm.vb#L27

Dim actualValue As New Measure("Sales")
actualValue.NumericFormat.FormatType = DataItemNumericFormatType.Currency
Dim targetValue As New Measure("SalesTarget")

wpf-dashboard-viewer-item-tabs/VB/WpfDashboardTabSupportExample/WpfDashboardTabSupportExample/DashboardItemGenerator.vb#L17

Dim actualValue As New Measure("Sales")
actualValue.NumericFormat.FormatType = DataItemNumericFormatType.Currency
Dim targetValue As New Measure("SalesTarget")

winforms-dashboard-viewer-item-tabs/VB/TabSupportExample/DashboardItemGenerator.vb#L22

Dim actualValue As New Measure("Sales")
actualValue.NumericFormat.FormatType = DataItemNumericFormatType.Currency
Dim targetValue As New Measure("SalesTarget")