Format Cell Values

• Dec 28, 2018
• 4 minutes to read

This topic describes approaches to formatting cell values.

	Approach	Affects Sorting / Filtering / Grouping	Supports Printing / Exporting	Works in Edit Mode
GridControl / GridColumn	CustomColumnDisplayText	*	(WYSIWYG mode only)
	Unbound Columns	*
	Columns with Binding	*
EditSettings	DisplayFormat	*
	DisplayTextConverter	*
	Masked Input	*
Cell Templates	DisplayFormatString
	DisplayTextConverter
	Masked Input

* Except Server Mode and Virtual Sources

GridControl / GridColumn

The GridControl / GridColumn support the following ways to format cell values:

CustomColumnDisplayText

The GridControl.CustomColumnDisplayText and TreeListView.CustomColumnDisplayText events allow you to customize text within any cell.

Xaml

<dxg:GridColumn FieldName="Value" /> 

C#

void grid_CustomColumnDisplayText(object sender, DevExpress.Xpf.Grid.CustomColumnDisplayTextEventArgs e) {
    if (e.Column.FieldName == "Value")
        e.DisplayText = string.Format("{0:n2}", e.Value);
} 

VB.NET

Private Sub grid_CustomColumnDisplayText(ByVal sender As Object, ByVal e As DevExpress.Xpf.Grid.CustomColumnDisplayTextEventArgs)
    If e.Column.FieldName = "Value" Then e.DisplayText = String.Format("{0:n2}", e.Value)
End Sub 

• Affects sorting/filtering/grouping: (except Server Mode and Virtual Sources)
• Supports printing/exporting: (WYSIWYG mode only)
• Works in edit mode:

Unbound Columns

The GridControl allows you to display Unbound Columns:

Xaml

<dxg:GridColumn FieldName="ValueUnbound" UnboundType="String" /> 

C#

private void grid_CustomUnboundColumnData(object sender, DevExpress.Xpf.Grid.GridColumnDataEventArgs e) {
    e.Value = string.Format("{0:n2}", e.GetListSourceFieldValue("Value"));
} 

VB.NET

Private Sub grid_CustomUnboundColumnData(ByVal sender As Object, ByVal e As DevExpress.Xpf.Grid.GridColumnDataEventArgs)
    e.Value = String.Format("{0:n2}", e.GetListSourceFieldValue("Value"))
End Sub 

• Affects sorting/filtering/grouping: (except Server Mode and Virtual Sources)
• Supports printing/exporting:
• Works in edit mode:

Columns with Binding

You can use the ColumnBase.Binding property to associate a grid column with a data source’s property. Refer to Columns with Binding for more information.

Xaml

<dxg:GridColumn Binding="{Binding Value, Converter={StaticResource myConverter} }" />

• Affects sorting/filtering/grouping: (except Server Mode and Virtual Sources)
• Supports printing/exporting:
• Works in edit mode:

EditSettings

You can use in-place data editors to edit cell values. Each editor has a helper class (the BaseEditSettings descendant) responsible for the editor’s functionality. You can use the column’s ColumnBase.EditSettings property to specify an in-place editor’s settings.

DisplayFormat

The BaseEditSettings.DisplayFormat property specifies the pattern used to format the editor’s display value.

For example, set the DisplayFormat property to c2 to display currency values. If the editor’s value is 99.9, its formatted equivalent is $99.90.

Xaml

<dxg:GridColumn EditSettings="{dxe:TextSettings DisplayFormat=c2}" FieldName="Value" /> 

Refer to the Format Specifiers topic for more information on the available DisplayFormat values.

• Affects sorting/filtering/grouping: (except Server Mode and Virtual Sources)
• Supports printing/exporting:
• Works in edit mode:

DisplayTextConverter

The BaseEditSettings.DisplayTextConverter property specifies a converter that provides the editor’s display value.

Xaml

<dxg:GridColumn EditSettings="{dxe:TextSettings DisplayTextConverter={...}}" FieldName="Value" /> 

• Affects sorting/filtering/grouping: (except Server Mode and Virtual Sources)
• Supports printing/exporting:
• Works in edit mode:

Masked Input

You can define an editor’s mask settings using the properties with the Mask prefix (for example, the TextEditSettings.MaskType, TextEditSettings.Mask, TextEditSettings.MaskCulture, etc.).

Masks are used in edit mode. Set the TextEditSettings.MaskUseAsDisplayFormat property to true to use the specified mask in display mode. If this property is false, the BaseEditSettings.DisplayFormat format specifies an editor’s display text.

Refer to Masked Input for more information.

Xaml

<dxg:GridColumn EditSettings="{dxe:TextSettings Mask=c, MaskUseAsDisplayFormat=True, MaskType=Numeric}" FieldName="Value" /> 

• Affects sorting/filtering/grouping: (except Server Mode and Virtual Sources)
• Supports printing/exporting:
• Works in edit mode:

Cell Templates

The ColumnBase.CellTemplate / DataViewBase.CellTemplate properties specify Cell Templates that define the column cells’ appearance.

Tip

You can use separate templates to present and edit data:

• ColumnBase.CellDisplayTemplate / DataViewBase.CellDisplayTemplate - Defines a template that displays column values.
• ColumnBase.CellEditTemplate / DataViewBase.CellEditTemplate - Defines a template that represents an editor used to edit cell values.

Note

Cell templates do not support Printing and Exporting. To print and export data with formatted cell values:

• Use the ColumnBase.PrintCellStyle / DataViewBase.PrintCellStyle to print and export data in WYSIWYG mode.
• Use the CsvExportOptionsEx.CustomizeCell / XlsExportOptionsEx.CustomizeCell / XlsxExportOptionsEx.CustomizeCell events to export data in Data-aware mode.

DisplayFormatString

The BaseEdit.DisplayFormatString property specifies the pattern used to format the editor’s display value.

For example, set the DisplayFormatString property to c2 to display currency values. If the editor’s value is 99.9, its formatted equivalent is $99.90.

Xaml

<dxg:GridColumn FieldName="Value">
    <dxg:GridColumn.CellTemplate>
        <DataTemplate>
            <dxe:TextEdit Name="PART_Editor" DisplayFormatString="c2" />
        </DataTemplate>
    </dxg:GridColumn.CellTemplate>
</dxg:GridColumn>

Refer to the Format Specifiers topic for more information on available DisplayFormatString values.

• Affects sorting/filtering/grouping:
• Supports printing/exporting:
• Works in edit mode:

DisplayTextConverter

The BaseEdit.DisplayTextConverter property specifies a converter that provides the editor’s display value.

Xaml

<dxg:GridColumn FieldName="Value">
    <dxg:GridColumn.CellTemplate>
        <DataTemplate>
            <dxe:TextEdit Name="PART_Editor" DisplayTextConverter="{...}" />
        </DataTemplate>
    </dxg:GridColumn.CellTemplate>
</dxg:GridColumn>

• Affects sorting/filtering/grouping:
• Supports printing/exporting:
• Works in edit mode:

Masked Input

You can define an editor’s mask settings using the properties with the Mask prefix (such as the TextEdit.MaskType, TextEdit.Mask, TextEdit.MaskCulture, etc.).

Masks are used in edit mode. Set the TextEdit.MaskUseAsDisplayFormat property to true to use the specified mask in display mode. If this property is false, the BaseEdit.DisplayFormatString format specifies an editor’s display text.

Refer to Masked Input for more information.

Xaml

<dxg:GridColumn FieldName="Value">
    <dxg:GridColumn.CellTemplate>
        <DataTemplate>
            <dxe:TextEdit Name="PART_Editor"
                        Mask="c"
                        MaskType="Numeric"
                        MaskUseAsDisplayFormat="True" />
        </DataTemplate>
    </dxg:GridColumn.CellTemplate>
</dxg:GridColumn>

• Affects sorting/filtering/grouping:
• Supports printing/exporting:
• Works in edit mode: