TreeListView.CustomColumnDisplayText Event

Enables custom display text to be provided for any data cell.

Namespace: DevExpress.Xpf.Grid

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

Declaration

C#

public event TreeListCustomColumnDisplayTextEventHandler CustomColumnDisplayText

VB.NET

Public Event CustomColumnDisplayText As TreeListCustomColumnDisplayTextEventHandler

Event Data

The CustomColumnDisplayText event's data class is TreeListCustomColumnDisplayTextEventArgs. 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.
Node	Gets the node which owns the processed cell.
ShowAsNullText	Specifies whether text corresponding to a null value appears faded.
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 view is printed.

The CustomColumnDisplayText event is raised only when a unique edit value is assigned to a grid cell.

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

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.

C#

wpf-spreadsheetcontrol-api-part-3-t289419/CS/SpreadsheetControl_WPF_API_Part03/MainWindow.xaml#L59

<dxg:TreeListControl.View>
    <dxg:TreeListView x:Name="view" TreeDerivationMode="ChildNodesSelector" ChildNodesSelector="{StaticResource childrenSelector}" ShowIndicator="False" ShowColumnHeaders="False" AutoWidth="True" AllowPerPixelScrolling="False" CustomColumnDisplayText="view_CustomColumnDisplayText" />
</dxg:TreeListControl.View>

wpf-spreadsheet-pivot-table-api-t314425/CS/SpreadsheetWPFPivotTableExamples/MainWindow.xaml#L52

<dxg:TreeListControl.View>
    <dxg:TreeListView x:Name="view" TreeDerivationMode="ChildNodesSelector" ChildNodesSelector="{StaticResource childrenSelector}" ShowIndicator="False" ShowColumnHeaders="False" AutoWidth="True" AllowPerPixelScrolling="False" CustomColumnDisplayText="view_CustomColumnDisplayText" />
</dxg:TreeListControl.View>

wpf-schedulercontrol-api-t442105/CS/SchedulerControl_WPF_API/MainWindow.xaml#L51

<dxg:TreeListControl.View>
    <dxg:TreeListView x:Name="view" TreeDerivationMode="ChildNodesSelector" ChildNodesSelector="{StaticResource childrenSelector}" ShowIndicator="False" ShowColumnHeaders="False" AutoWidth="True" AllowPerPixelScrolling="False" CustomColumnDisplayText="view_CustomColumnDisplayText" />
</dxg:TreeListControl.View>

wpf-spreadsheet-chart-api-t113198/CS/SpreadsheetWPFChartAPISamples/MainWindow.xaml#L53

<dxg:TreeListControl.View>
    <dxg:TreeListView x:Name="view" TreeDerivationMode="ChildNodesSelector" ChildNodesSelector="{StaticResource childrenSelector}" ShowIndicator="False" ShowColumnHeaders="False" AutoWidth="True" AllowPerPixelScrolling="False" CustomColumnDisplayText="view_CustomColumnDisplayText" />
</dxg:TreeListControl.View>

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/MainWindow.xaml#L58

<dxg:TreeListControl.View>
    <dxg:TreeListView x:Name="view" TreeDerivationMode="ChildNodesSelector" ChildNodesSelector="{StaticResource childrenSelector}" ShowIndicator="False" ShowColumnHeaders="False" AutoWidth="True" AllowPerPixelScrolling="False" CustomColumnDisplayText="view_CustomColumnDisplayText" />
</dxg:TreeListControl.View>