HtmlContentPopup.CustomDisplayText Event

Allows you to specify custom display text for bound field values.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

[DXCategory("Events")]
public event CustomDisplayTextEventHandler CustomDisplayText

VB.NET

<DXCategory("Events")>
Public Event CustomDisplayText As CustomDisplayTextEventHandler

Event Data

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

Property	Description
DisplayText	Gets or sets an editor’s display text.
Value	Gets an editor’s current value.

Remarks

The ${FieldName} syntax in HTML markup inserts values of fields/properties from the control’s data context (HtmlContentPopup.DataContext). See the following article for more information: Data Binding.

The CustomDisplayText event allows you to specify custom display text for bound field values. The event contains the following arguments:

• PropertyName — The name of the bound field for which you need to return custom text.
• Value — Specifies the bound field’s value.
• DisplayText — Gets or sets custom display text of the Value. The parameter initially contains the default text presentation of the Value object.

The following example handles the CustomDisplayText event to wrap email addresses in apostrophes:

C#

void OnCustomDisplayText(object sender, HtmlContentCustomDisplayTextEventArgs e) {
    if(e.PropertyName == "Email")
        e.DisplayText = "'" + e.DisplayText + "'";
}

VB.NET

Private Sub OnCustomDisplayText(sender As Object, e As DevExpress.XtraEditors.HtmlContentCustomDisplayTextEventArgs) Handles HtmlContentControl1.CustomDisplayText
    If e.PropertyName = "Email" Then
        e.DisplayText = "'" & e.DisplayText & "'"
    End If

HTML

<div class='content'>${Email}</div>