RepositoryItemPopupContainerEdit.QueryDisplayText Event

Enables you to specify the display text for the editor.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

[DXCategory("Events")]
public event QueryDisplayTextEventHandler QueryDisplayText

VB.NET

<DXCategory("Events")>
Public Event QueryDisplayText As QueryDisplayTextEventHandler

Event Data

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

Property	Description
DisplayText	Gets or sets the text to display in the edit box.
EditValue	Gets the current edit value.

Remarks

The QueryDisplayText event is raised each time the editor needs to update its display value. Handle the event to provide the display text manually. To do so, assign the desired string to the QueryDisplayTextEventArgs.DisplayText property value. The QueryDisplayTextEventArgs.EditValue property lets you identify the editor value which is to be formatted.

Generally, if you handle the QueryDisplayText event, you will set the RepositoryItemPopupContainerEdit.TextEditStyle property to TextEditStyles.DisableTextEditor. Otherwise, the user input may interfere with your custom display text.

The editor’s PopupContainerEdit.QueryDisplayText event is equivalent to the current event.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the QueryDisplayText event.

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-create-a-popupcontaineredit-control-with-a-checkedlistboxcontrol-in-the-popuform-e4688/CS/NewProject/PopupContainerEditHelper.cs#L34

    RepositoryItem.QueryResultValue += new QueryResultValueEventHandler(RepositoryItem_QueryResultValue);
    RepositoryItem.QueryDisplayText += new QueryDisplayTextEventHandler(RepositoryItem_QueryDisplayText);
}

VB.NET

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

    AddHandler RepositoryItem.QueryResultValue, AddressOf RepositoryItem_QueryResultValue
    AddHandler RepositoryItem.QueryDisplayText, AddressOf RepositoryItem_QueryDisplayText
End Sub