CustomColumnDisplayTextEventArgs Class

Provides data for the ColumnView.CustomColumnDisplayText event.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v18.1.dll

Declaration

C#

public class CustomColumnDisplayTextEventArgs :
    EventArgs

VB.NET

Public Class CustomColumnDisplayTextEventArgs
    Inherits EventArgs

Related API Members

CustomColumnDisplayTextEventArgs is the data class for the following events:

• ColumnView.CustomColumnDisplayText

Remarks

The ColumnView.CustomColumnDisplayText event can be used to provide custom display text for specific cells in a View.

The cell currently being processed is referred to by the column and row. The column is specified by the CustomColumnDisplayTextEventArgs.Column property. The row can be identified by the CustomColumnDisplayTextEventArgs.ListSourceRowIndex property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomColumnDisplayTextEventArgs class.

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-an-image-in-a-group-row-e5041/CS/Form1.cs#L34

}
private void gridView1_CustomColumnDisplayText(object sender, CustomColumnDisplayTextEventArgs e) {
    if (e.Column.FieldName == "Subject")

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/CS/E4669CS/CustomFieldFilterControl.cs#L166

private void gridView1_CustomColumnDisplayText(object sender, DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs e)
{

how-to-customize-the-resulting-file-during-printing-exporting-gridcontrol-e2722/CS/WindowsApplication1/GridExportHelper.cs#L75

void view_CustomColumnDisplayText(object sender, DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs e)
{

how-to-make-richedit-highlight-strings-that-match-the-find-panel-text-e4422/CS/E4422/Form1.cs#L23

private void OnCustomColumnDisplayText(object sender, DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs e) {
    if (e.Column == colDescription && !string.IsNullOrEmpty(gridView1.FindFilterText)) {

how-create-file-manager-using-gridcontrol-e3053/CS/GridCommander/CommanderTab.cs#L97

private void gridView1_CustomColumnDisplayText(object sender, DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs e) {
    GridView view = sender as GridView;

VB.NET

how-to-display-an-image-in-a-group-row-e5041/VB/Form1.vb#L36

End Sub
Private Sub gridView1_CustomColumnDisplayText(ByVal sender As Object, ByVal e As CustomColumnDisplayTextEventArgs) Handles gridView1.CustomColumnDisplayText
    If e.Column.FieldName = "Subject" Then

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/VB/CustomFieldFilterControl.vb#L162

Private Sub gridView1_CustomColumnDisplayText(sender As System.Object, e As DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs) Handles gridView1.CustomColumnDisplayText
    If e.Value Is Nothing OrElse e.Value.Equals(AllItem) Then Return

how-to-customize-the-resulting-file-during-printing-exporting-gridcontrol-e2722/VB/GridExportHelper.vb#L62

Private Sub view_CustomColumnDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs)
    e.DisplayText = String.Format("[{0}]", e.DisplayText)

how-to-make-richedit-highlight-strings-that-match-the-find-panel-text-e4422/VB/E4422/Form1.vb#L25

Private Sub OnCustomColumnDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs)
    If e.Column Is colDescription AndAlso (Not String.IsNullOrEmpty(gridView1.FindFilterText)) Then

how-create-file-manager-using-gridcontrol-e3053/VB/GridCommander/CommanderTab.vb#L105

Private Sub gridView1_CustomColumnDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs) Handles gridView1.CustomColumnDisplayText
    Dim view = CType(sender, GridView)

Inheritance

Object

EventArgs

CustomColumnDisplayTextEventArgs