Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

HtmlContentControl.CustomDisplayText Event

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

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

#Declaration

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

#Event Data

The CustomDisplayText event's data class is DevExpress.XtraEditors.HtmlContentCustomDisplayTextEventArgs.

#Remarks

The ${FieldName} syntax in HTML markup inserts values of fields/properties from the control’s data context (HtmlContentControl.DataContext). See 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 e-mail addresses in apostrophes:

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