ASPxTreeList.CustomColumnDisplayText Event

Enables custom display text to be provided for any cell.

Namespace: DevExpress.Web.ASPxTreeList

Assembly: DevExpress.Web.ASPxTreeList.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public event TreeListCustomColumnDisplayTextEventHandler CustomColumnDisplayText

VB.NET

Public Event CustomColumnDisplayText As TreeListCustomColumnDisplayTextEventHandler

Event Data

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

Property	Description
Column	Gets the processed column.
DisplayText	Enables you to set a custom text for the cell currently being processed.
EncodeHtml	Gets or sets a value that specifies whether the cell display text keeps any of its values that are HTML as HTML, or instead, strips out the HTML markers.
NodeKey	Gets the processed node’s key value.
Value	Gets the edit value of the cell currently being processed.

Remarks

The CustomColumnDisplayText event can be used to provide custom display text for any cell. This event is fired for both bound and unbound columns.

Initially, the TreeListColumnDisplayTextEventArgs.DisplayText parameter returns null. To provide custom display text, assign the required string to this parameter. To get the current cell value, use the TreeListColumnDisplayTextEventArgs.Value parameter.

The CustomColumnDisplayText event fires in two cases.

• When the control hierarchy is being built.
• When a grid is sorted by display text (the TreeListSettingsBehavior.SortMode property is set to DisplayText).

Note

The CustomColumnDisplayText event should not be handled for template columns.

Example

This example demonstrates how to display the “empty” string within the Units On Order column’s data cells if they contain zero values.

The image below shows the result:

C#

protected void ASPxTreeList1_CustomColumnDisplayText(object sender, DevExpress.Web.ASPxTreeList.TreeListColumnDisplayTextEventArgs e)
{
    if (e.Column.FieldName != "UnitsOnOrder") return;
    if (Convert.ToInt32(e.Value) == 0)
        e.DisplayText = "empty";
}