Back to Devexpress

RepositoryItemPopupContainerEdit.QueryDisplayText Event

windowsforms-devexpress-dot-xtraeditors-dot-repository-dot-repositoryitempopupcontaineredit-eac75552.md

latest3.2 KB
Original Source

RepositoryItemPopupContainerEdit.QueryDisplayText Event

Enables you to specify the display text for the editor.

Namespace : DevExpress.XtraEditors.Repository

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DXCategory("Events")]
public event QueryDisplayTextEventHandler QueryDisplayText
vb
<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:

PropertyDescription
DisplayTextGets or sets the text to display in the edit box.
EditValueGets 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.

See Also

QueryDisplayText

QueryResultValue

TextEditStyle

Popup Container Editor

RepositoryItemPopupContainerEdit Class

RepositoryItemPopupContainerEdit Members

DevExpress.XtraEditors.Repository Namespace