GridControl.CustomColumnDisplayText Event

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

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Grid.Core, 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 can be used to display custom text within any cell. This event is fired for both bound and unbound columns. The text provided via this event will be used when the grid is printed.

Initially, the CustomColumnDisplayTextEventArgs.DisplayText parameter contains the cell’s current display text. To provide custom display text, assign the required string to this property.

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 

The CustomColumnDisplayText event is called in various instances:

• To provide a cell’s display text when data is not sorted by a column.

• To provide column display text and compare the supplied strings when data is grouped or sorted by this column.

  In this instance, the event’s RowHandle and ListSourceRowIndex parameters return invalid values, and it is not possible to determine the currently processed row, and therefore obtain other cell values.

• To supply text to display within a column’s Filter DropDown.

  In this instance, the event’s RowHandle and ListSourceRowIndex parameters return invalid values, and it’s not possible to determine the currently processed row, and therefore obtain other cell values.

This means, that in most instances the CustomColumnDisplayText event cannot be used to supply custom display text to a column based on values of other cells. A solution to this task is to create an unbound column to provide custom display text.

Tip

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/DXGrid_DisplayCustomText/Window1.xaml#L3

<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>