GridControl.CustomColumnDisplayText Event

Allows you to customize a data cell‘s display text.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v21.1.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public event CustomColumnDisplayTextEventHandler CustomColumnDisplayText

VB.NET

Public Event CustomColumnDisplayText As CustomColumnDisplayTextEventHandler

Event Data

The CustomColumnDisplayText event's data class is CustomColumnDisplayTextEventArgs. The following properties provide information specific to this event:

Property	Description
Column	Gets the column which owns the processed cell.
DisplayText	Gets or sets the display text for the cell currently being processed.
ListSourceIndex	Gets the index of a record in a data source that corresponds to the processed data row.
Row	Gets the row which owns the processed cell.
RowHandle	Gets the processed row’s handle.
ShowAsNullText	Specifies whether text corresponding to a null value appears faded.
Source	Gets the grid control that raised the event.
Value	Gets the processed cell’s value.

Remarks

The CustomColumnDisplayText event occurs for both bound and unbound columns. The printed GridControl displays customized text as well.

If you want to maintain a clean MVVM pattern and customize a data cell’s display text in a View Model, create a command and bind it to the CustomColumnDisplayTextCommand property.

The CustomColumnDisplayTextEventArgs.DisplayText property contains a cell’s current display text. To customize the display text, assign a string value to this property.

Xaml

<dxg:GridColumn FieldName="Value"/>

C#

void grid_CustomColumnDisplayText(object sender, 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 CustomColumnDisplayTextEventArgs)
    If e.Column.FieldName = "Value" Then e.DisplayText = String.Format("{0:n2}", e.Value)
End Sub 

If column data is sorted or grouped, the event’s RowHandle and ListSourceRowIndex properties return invalid values. As a result, you cannot determine the processed row and obtain other cell values. To customize display text, you can instead use techniques described in the following topic: Format Cell Values.

Related GitHub Examples

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

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.

XAML

how-to-display-custom-text-within-dxgrid-cells-e2020/CS/DisplayCustomText_CodeBehind/MainWindow.xaml#L11

<Grid>
    <dxg:GridControl CustomColumnDisplayText="gridControl1_CustomColumnDisplayText" Name="gridControl1">
        <dxg:GridControl.Columns>

how-to-display-custom-text-within-data-cells-and-groups-t327301/CS/DXSample/MainWindow.xaml#L14

ItemsSource="{Binding}"
CustomColumnDisplayText="GridControl_CustomColumnDisplayText"
CustomGroupDisplayText="GridControl_CustomGroupDisplayText">

how-to-show-the-appointments-search-result-in-searchresult-view-for-schedulercontrol-simil-t278605/CS/SearchResultViewDemo/SearchResultView.xaml#L15

             FilterCriteria="{Binding Path=FilterCriteria, RelativeSource={RelativeSource Mode=FindAncestor, AncestorType=UserControl}}"
             CustomColumnDisplayText="searchResultGrid_CustomGroupDisplayText">
<dxg:GridControl.Columns>