QueryDisplayTextEventArgs Class

Provides data for the RepositoryItemPopupContainerEdit.QueryDisplayText and RepositoryItemPopupGalleryEdit.QueryDisplayText events.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

public class QueryDisplayTextEventArgs :
    EventArgs

VB.NET

Public Class QueryDisplayTextEventArgs
    Inherits EventArgs

Related API Members

QueryDisplayTextEventArgs is the data class for the following events:

• CheckedComboBoxEdit.QueryDisplayText
• PopupContainerEdit.QueryDisplayText
• RepositoryItemCheckedComboBoxEdit.QueryDisplayText
• RepositoryItemPopupContainerEdit.QueryDisplayText
• RepositoryItemPopupGalleryEdit.QueryDisplayText

Remarks

The RepositoryItemPopupContainerEdit.QueryDisplayText and RepositoryItemPopupGalleryEdit.QueryDisplayText events allow you to specify custom display text for the PopupContainerEdit and PopupGalleryEdit controls. The QueryDisplayTextEventArgs class provides the QueryDisplayTextEventArgs.DisplayText property that specifies the text to display within the edit box. The QueryDisplayTextEventArgs.EditValue property allows you to obtain the current edit value.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the QueryDisplayTextEventArgs 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-rich-text-in-gridviews-cells-but-edit-their-content-in-a-popup-window-e2503/CS/Form1.cs#L66

void riPopup_QueryDisplayText(object sender, QueryDisplayTextEventArgs e)
{

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

}
void RepositoryItem_QueryDisplayText(object sender, QueryDisplayTextEventArgs e)
{

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

protected override void PreQueryDisplayText(QueryDisplayTextEventArgs e)
{

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

void popupContainerEdit1_QueryDisplayText(object sender, DevExpress.XtraEditors.Controls.QueryDisplayTextEventArgs e)
{

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

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#L63

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

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

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

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

Protected Overrides Sub PreQueryDisplayText(ByVal e As QueryDisplayTextEventArgs)
    If CanRaiseConvertEditValueToCheckState AndAlso e.EditValue IsNot Nothing Then

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

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(), "")

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

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

Inheritance

Object

EventArgs

QueryDisplayTextEventArgs