Tab

EditPropertiesBase.DisplayFormatString Property

Gets or sets the pattern used to format the editor's value for display purposes.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v20.2.dll

Declaration

[DefaultValue("")]
public virtual string DisplayFormatString { get; set; }
<DefaultValue("")>
Public Overridable Property DisplayFormatString As String

Property Value

Type Default Description
String

String.Empty

A string representing the format pattern.

Remarks

When an editor is used within a complex data control (such as ASPxGridView or ASPxTreeList) to display and edit column data, the DisplayFormatString property can be used to specify a format pattern used to represent the editor's value in a column while the data control is in browse mode. You can also apply this format to the value displayed within the editor's input box when the data control is in edit mode. For this purpose, enable the DevExpress.Web.ASPxEditors.TextEditProperties.DisplayFormatInEditMode property.

NOTE

Display values can be formatted using the standard formatting mechanism described in MSDN. It allows you to format values using standard format patterns. Format specifiers for composing a format pattern are described in the Standard Numeric Format Strings and Standard Date and Time Format Strings topics in MSDN.

Online demos

Example

The code sample below demonstrates how you can use the DisplayFormatString property to represent data with a dollar sign ($).

Web Forms approach:

<dx:GridViewDataTextColumn FieldName="UnitPrice" VisibleIndex="1">
    <PropertiesTextEdit DisplayFormatString="c" />
</dx:GridViewDataTextColumn>

EditPropertiesBase - DisplayFormatString

MVC approach:

NOTE

For a full example, see the CardView - Sorting (MVC) demo.

@Html.DevExpress().CardView( settings => {
    settings.Name = "CardView";
    ...
    settings.Columns.Add(c =>{
        c.FieldName = "Price";
        c.SortOrder = ColumnSortOrder.Ascending;
        c.PropertiesEdit.DisplayFormatString = "c";
    });
    settings.Columns.Add(c => {
        c.FieldName = "PhotoUrl";
        c.ColumnType = MVCxCardViewColumnType.Image;
        ((ImageEditProperties)c.PropertiesEdit).ImageWidth = 250;
    });

    ...
}).Bind(Model).GetHtml()

ASPxCardViewColumn-DisplayFormatString

See Also