A newer version of this page is available. Switch to the current version.

RepositoryItemPopupContainerEdit.QueryDisplayText Event

Enables you to specify the display text for the editor.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

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

See Also