FormatInfo.FormatString Property

Gets the pattern for formatting values.

Namespace: DevExpress.Utils

Assembly: DevExpress.Data.v19.2.dll

Declaration

C#

public virtual string FormatString { get; set; }

VB.NET

Public Overridable Property FormatString As String

Property Value

Type	Description
String	The string representing the format pattern.

Remarks

Use the FormatString property to specify the format pattern for formatting values.

Standard format specifiers for composing the format pattern are described in the Standard Numeric Format Strings and Date and Time Format Strings topics in MSDN.

In addition to the format string, you need to specify the format provider which contains information how to interpret the format string. This can be done by defining one of the following properties:

1. FormatInfo.FormatType. Use this property if you wish to format values based on the current language and regional settings (culture).

   Note

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

2. FormatInfo.Format. The property allows you to specify the format provider for a specific culture.

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 FormatString 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-create-a-masked-editor-with-specified-ranges-for-every-mask-part-e3379/CS/RangedMaskSample/RepositoryItemMaskButtonEdit.cs#L120

{
    EditFormat.FormatString = string.Empty;
    DisplayFormat.FormatString = string.Empty;

how-to-create-an-ip-address-editor-to-cycle-through-every-part-of-an-ip-address-e2443/CS/IPAddressEditor/RepositoryItemIPAddressEdit.cs#L92

{
    EditFormat.FormatString = EditMask;
    DisplayFormat.FormatString = EditMask;

how-to-edit-timespan-data-in-standalone-and-in-place-mode-e1976/CS/TimeSpanEditor/TimeSpanEditor.cs#L61

protected virtual void UpdateFormats() {
    EditFormat.FormatString = EditMask;
    DisplayFormat.FormatString = EditMask;

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

if(gridColumn.DisplayFormat.FormatType == FormatType.DateTime)
    column.ApplyFormatting(XlCellFormatting.FromNetFormat(gridColumn.DisplayFormat.FormatString, true));
else if(gridColumn.DisplayFormat.FormatType != FormatType.None)

dateedit-how-to-select-multiple-dates-e2007/CS/DatePeriodEdit/DatePeriodEdit.cs#L75

if (period != null)
    displayText = period.ToString(format.FormatString, SeparatorChar);
else

VB.NET

how-to-create-a-masked-editor-with-specified-ranges-for-every-mask-part-e3379/VB/RangedMaskSample/RepositoryItemMaskButtonEdit.vb#L104

If aHardUpdate Then
    EditFormat.FormatString = String.Empty
    DisplayFormat.FormatString = String.Empty

how-to-create-an-ip-address-editor-to-cycle-through-every-part-of-an-ip-address-e2443/VB/IPAddressEditor/RepositoryItemIPAddressEdit.vb#L77

Protected Overridable Sub UpdateFormats()
    EditFormat.FormatString = EditMask
    DisplayFormat.FormatString = EditMask

how-to-edit-timespan-data-in-standalone-and-in-place-mode-e1976/VB/TimeSpanEditor/TimeSpanEditor.vb#L89

Protected Overridable Sub UpdateFormats()
    EditFormat.FormatString = EditMask
    DisplayFormat.FormatString = EditMask

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

If gridColumn.DisplayFormat.FormatType = FormatType.DateTime Then
    column.ApplyFormatting(XlCellFormatting.FromNetFormat(gridColumn.DisplayFormat.FormatString, True))
ElseIf gridColumn.DisplayFormat.FormatType <> FormatType.None Then

dateedit-how-to-select-multiple-dates-e2007/VB/DatePeriodEdit/DatePeriodEdit.vb#L79

If period_Renamed IsNot Nothing Then
    displayText = period_Renamed.ToString(format.FormatString, SeparatorChar)
Else