TreeList.CustomColumnDisplayText Event

Fires for both bound and unbound Tree List columns and allows you to provide a custom display text for any cell.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v23.2.dll

NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.TreeList

Declaration

C#

[DXCategory("Data")]
public event CustomColumnDisplayTextEventHandler CustomColumnDisplayText

VB.NET

<DXCategory("Data")>
Public Event CustomColumnDisplayText As CustomColumnDisplayTextEventHandler

Event Data

The CustomColumnDisplayText event's data class is DevExpress.XtraTreeList.CustomColumnDisplayTextEventArgs.

Remarks

The example below illustrates how to replace the “0%” text with empty strings for all cells within the “Discount” column.

C#

private void treeList1_CustomColumnDisplayText(object sender, DevExpress.XtraTreeList.CustomColumnDisplayTextEventArgs e) {
    if (e.Column.Caption == "Discount" && e.DisplayText == "0%")
        e.DisplayText = "";
}

VB.NET

Private Sub treeList1_CustomColumnDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraTreeList.CustomColumnDisplayTextEventArgs)
    If e.Column.Caption = "Discount" AndAlso e.DisplayText = "0%" Then
        e.DisplayText = ""
    End If
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.

C#

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.cs#L27

tree.AfterCheckNode += Tree_AfterCheckNode;
tree.CustomColumnDisplayText += Tree_CustomColumnDisplayText;
tree.CustomDrawEmptyArea += Tree_CustomDrawEmptyArea;

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.vb#L31

AddHandler tree.AfterCheckNode, AddressOf Tree_AfterCheckNode
AddHandler tree.CustomColumnDisplayText, AddressOf Tree_CustomColumnDisplayText
AddHandler tree.CustomDrawEmptyArea, AddressOf Tree_CustomDrawEmptyArea