CustomColumnDisplayTextEventArgs.DisplayText Property

Gets or sets the display text for the cell currently being processed.

Namespace: DevExpress.Xpf.Grid

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

Declaration

C#

public string DisplayText { get; set; }

VB.NET

Public Property DisplayText As String

Property Value

Type	Description
String	A String value that specifies the cell’s display text.

Remarks

Initially, when handling the GridControl.CustomColumnDisplayText event, the DisplayText property contains the text currently displayed within the processed cell. To replace the default text with the custom text, assign it to the DisplayText property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DisplayText 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-display-custom-text-within-data-cells-and-groups-t327301/CS/DXSample/MainWindow.xaml.cs#L15

case 0:
    e.DisplayText = "User";
    break;

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

case "ResourceId":
    e.DisplayText = OwnerScheduler.Storage.ResourceStorage.GetResourceById(e.Value).Caption;
    break;

how-to-display-custom-text-within-dxgrid-cells-e2020/CS/DXGrid_DisplayCustomText/Window1.xaml.cs#L15

    if ((double)gridControl1.GetCellValue(e.RowHandle, "Discount") > 20)
        e.DisplayText = ((string)e.Value) + " (SALE)";
}

VB.NET

how-to-display-custom-text-within-data-cells-and-groups-t327301/VB/DXSample/MainWindow.xaml.vb#L17

Case 0
    e.DisplayText = "User"
Case 1

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

Case "ResourceId"
    e.DisplayText = OwnerScheduler.Storage.ResourceStorage.GetResourceById(e.Value).Caption
Case "LabelId"

how-to-display-custom-text-within-dxgrid-cells-e2020/VB/DXGrid_DisplayCustomText/Window1.xaml.vb#L20

If CDbl(gridControl1.GetCellValue(e.RowHandle, "Discount")) > 20 Then
    e.DisplayText = (CStr(e.Value)) & " (SALE)"
End If