QueryDisplayTextEventArgs.DisplayText Property

Gets or sets the text to display in the edit box.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public string DisplayText { get; set; }

VB.NET

Public Property DisplayText As String

Property Value

Type	Description
String	A string value specifying the editor’s formatted display text.

Remarks

Initially the DisplayText property depends on the RepositoryItem.EditFormat or RepositoryItem.DisplayFormat property value, depending on whether the editor is focused.

You can change the display text as required and thus override the default text representation. The edit value to be formatted is passed as the QueryDisplayTextEventArgs.EditValue property.

Related GitHub Examples

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

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-rich-text-in-gridviews-cells-but-edit-their-content-in-a-popup-window-e2503/CS/Form1.cs#L68

{
    e.DisplayText = richEditControl.Document.Text;
}

how-to-create-a-popupcontaineredit-control-with-a-checkedlistboxcontrol-in-the-popuform-e4688/CS/NewProject/PopupContainerEditHelper.cs#L38

{
    e.DisplayText = string.Join(";", GetCheckedText());
}

how-to-create-a-checkedcomboboxedit-descendant-that-stores-edit-values-in-a-custom-format-e1987/CS/CustomCheckedComboBox/CustomCheckedComboBoxEdit.cs#L73

    RaiseConvertEditValueToCheckState(ea);
    e.DisplayText = makeNormalValue(ea.CheckedState);
}

how-to-emulate-an-editable-gridlookupedit-with-popupcontaineredit-e3078/CS/PopupContainerEditSelection/Form1.cs#L41

{
    e.DisplayText = e.EditValue != null ? e.EditValue.ToString() : "";
}

how-to-implement-the-in-place-popupcontaineredit-with-the-dynamic-popup-content-e1305/CS/Q148684/Form1.cs#L72

private void OnDetailsEditQueryDisplayText(object sender, QueryDisplayTextEventArgs e) {
    e.DisplayText = "Edit Details";
}

VB.NET

how-to-display-rich-text-in-gridviews-cells-but-edit-their-content-in-a-popup-window-e2503/VB/Form1.vb#L64

Private Sub riPopup_QueryDisplayText(ByVal sender As Object, ByVal e As QueryDisplayTextEventArgs) Handles riPopup.QueryDisplayText
    e.DisplayText = richEditControl.Document.Text
End Sub

how-to-create-a-popupcontaineredit-control-with-a-checkedlistboxcontrol-in-the-popuform-e4688/VB/NewProject/PopupContainerEditHelper.vb#L35

Private Sub RepositoryItem_QueryDisplayText(ByVal sender As Object, ByVal e As QueryDisplayTextEventArgs)
    e.DisplayText = String.Join(";", GetCheckedText())
End Sub

how-to-create-a-checkedcomboboxedit-descendant-that-stores-edit-values-in-a-custom-format-e1987/VB/CustomCheckedComboBox/CustomCheckedComboBoxEdit.vb#L77

    RaiseConvertEditValueToCheckState(ea)
    e.DisplayText = makeNormalValue(ea.CheckedState)
End If

how-to-emulate-an-editable-gridlookupedit-with-popupcontaineredit-e3078/VB/PopupContainerEditSelection/Form1.vb#L37

Private Sub popupContainerEdit1_QueryDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.QueryDisplayTextEventArgs)
    e.DisplayText = If(e.EditValue IsNot Nothing, e.EditValue.ToString(), "")
End Sub

how-to-implement-the-in-place-popupcontaineredit-with-the-dynamic-popup-content-e1305/VB/Q148684/Form1.vb#L77

Private Sub OnDetailsEditQueryDisplayText(ByVal sender As Object, ByVal e As QueryDisplayTextEventArgs) Handles detailsEdit.QueryDisplayText
    e.DisplayText = "Edit Details"
End Sub