FormatInfo.FormatType Property

Gets or sets the type of formatting specified by the current FormatInfo object.

Namespace: DevExpress.Utils

Assembly: DevExpress.Data.v20.2.dll

NuGet Packages: DevExpress.Data, DevExpress.WindowsDesktop.Data

Declaration

C#

public virtual FormatType FormatType { get; set; }

VB.NET

Public Overridable Property FormatType As FormatType

Property Value

Type	Description
FormatType	One of FormatType values specifying the formatting type.

Available values:

Name	Description
None	No formatting is performed. Setting the FormatInfo.FormatType property to None clears the FormatInfo.FormatString property and sets the FormatInfo.Format object to null.
Numeric	Specifies that values should be formatted as numbers. Setting FormatInfo.FormatType to Numeric assigns the static System.Globalization.NumberFormatInfo.CurrentInfo format provider to the FormatInfo.Format property. This defines the format provider for the current culture. Also FormatInfo.FormatString is set to an empty string.
DateTime	Specifies that values should be formatted as the DateTime type. Setting FormatInfo.FormatType to DateTime assigns the static CurrentInfo format provider to the FormatInfo.Format property. This defines the format provider for the current culture. Also FormatInfo.FormatString is set to “d” (short date pattern).
Custom	Use Custom to format string values. Use Custom when assigning a custom IFormatProvider to the FormatInfo.Format property. Setting FormatInfo.FormatType to Custom does not change the FormatInfo.Format and FormatInfo.FormatString property values.

Remarks

Use the FormatType and FormatInfo.FormatString properties to format values based on the current language and regional settings (culture). FormatType specifies the type of values to be formatted. FormatInfo.FormatString specifies a format pattern appropriate for the current FormatType value. You can refer to the Standard Numeric Format Strings and Date and Time Format Strings topics in MSDN for information on format specifiers.

Note

Changing the FormatType property automatically resets the FormatString property. Thus, it is recommended to set FormatType prior to FormatString.

Setting the FormatType property changes the format provider used when formatting values by the FormatInfo.GetDisplayText function.

Format providers supply information such as the character to use as the decimal point when formatting numeric strings and the separation character to use when formatting a DateTime object. The FormatInfo.Format property specifies the format provider to use.

You can change the FormatInfo.Format property explicitly by assigning a IFormatProvider object. This can be useful if you wish to format values according to a specific culture (not the current one). In this case, you also need to set the FormatType property to FormatType.Custom.

See Formatting Values, to learn more.

Example

The sample code below formats display values of the date and text editors. The FormatInfo.FormatType and FormatInfo.FormatString properties of the editor’s RepositoryItem.DisplayFormat object are used for this purpose.

The image below displays the editors before and after formatting their display values.

C#

dateEdit1.Properties.DisplayFormat.FormatType = FormatType.DateTime;
dateEdit1.Properties.DisplayFormat.FormatString = "MMMM/yyyy";
textEdit1.Properties.DisplayFormat.FormatType = FormatType.Numeric;
textEdit1.Properties.DisplayFormat.FormatString = "c2";

VB.NET

DateEdit1.Properties.DisplayFormat.FormatType = FormatType.DateTime
DateEdit1.Properties.DisplayFormat.FormatString = "MMMM/yyyy"
TextEdit1.Properties.DisplayFormat.FormatType = FormatType.Numeric
TextEdit1.Properties.DisplayFormat.FormatString = "c2"

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#

how-to-copy-cell-data-in-an-excel-format-biff8-to-the-clipboard-using-xl-export-library-t266171/CS/gridCopyToClipboardExample/CopyToClipboardHelper.cs#L32

// Setup number format
if(gridColumn.DisplayFormat.FormatType == FormatType.DateTime)
    column.ApplyFormatting(XlCellFormatting.FromNetFormat(gridColumn.DisplayFormat.FormatString, true));

pivot-grid-aggr-examples/CS/Pivot-Aggr-Examples/CodeFiles/CodeExample.cs#L49

};
salesByYearByCountry.CellFormat.FormatType = DevExpress.Utils.FormatType.Custom;
salesByYearByCountry.CellFormat.FormatString = "c";

how-to-provide-the-ability-to-resize-rows-e617/CS/Form1.cs#L183

gridControl1.DefaultView.PopulateColumns();
gridView1.Columns["Payment Amount"].DisplayFormat.FormatType = DevExpress.Utils.FormatType.Numeric;
gridView1.Columns["Payment Amount"].DisplayFormat.FormatString = "c";

winforms-pivot-access-other-cell-value-while-calculating-the-current-cell/CS/WinAppCustomCellValue/Form1.cs#L23

fieldPercentOfBeverages.CellFormat.FormatType = DevExpress.Utils.FormatType.Numeric;
fieldPercentOfBeverages.CellFormat.FormatString = "P";

how-to-asynchronously-load-large-data-in-an-unbound-column-e4539/CS/WindowsApplication3/Main.cs#L58

// Specify format settings.
unbColumn.DisplayFormat.FormatType = DevExpress.Utils.FormatType.Custom;
// Customize the appearance settings.

VB.NET

how-to-copy-cell-data-in-an-excel-format-biff8-to-the-clipboard-using-xl-export-library-t266171/VB/gridCopyToClipboardExample/CopyToClipboardHelper.vb#L34

' Setup number format
If gridColumn.DisplayFormat.FormatType = FormatType.DateTime Then
    column.ApplyFormatting(XlCellFormatting.FromNetFormat(gridColumn.DisplayFormat.FormatString, True))

pivot-grid-aggr-examples/VB/Pivot-Aggr-Examples/CodeFiles/CodeExample.vb#L46

salesByYearByCountry.SummaryType = PivotSummaryType.Average
salesByYearByCountry.CellFormat.FormatType = DevExpress.Utils.FormatType.Custom
salesByYearByCountry.CellFormat.FormatString = "c"

how-to-provide-the-ability-to-resize-rows-e617/VB/Form1.vb#L176

gridControl1.DefaultView.PopulateColumns()
gridView1.Columns("Payment Amount").DisplayFormat.FormatType = DevExpress.Utils.FormatType.Numeric
gridView1.Columns("Payment Amount").DisplayFormat.FormatString = "c"

winforms-pivot-access-other-cell-value-while-calculating-the-current-cell/VB/WinAppCustomCellValue/Form1.vb#L16

fieldPercentOfBeverages.CellFormat.FormatType = DevExpress.Utils.FormatType.Numeric
fieldPercentOfBeverages.CellFormat.FormatString = "P"

how-to-asynchronously-load-large-data-in-an-unbound-column-e4539/VB/WindowsApplication3/Main.vb#L63

' Specify format settings.
unbColumn.DisplayFormat.FormatType = DevExpress.Utils.FormatType.Custom
' Customize the appearance settings.