ProcessNewValueEventArgs.DisplayValue Property

Gets or sets the value entered by the end-user.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public object DisplayValue { get; set; }

VB.NET

Public Property DisplayValue As Object

Property Value

Type	Description
Object	An object representing the value entered by the end-user.

Remarks

When the end-user enters text within the lookup editor’s edit box that does not match the RepositoryItemLookUpEditBase.DisplayMember field value of any dropdown row, the RepositoryItemLookUpEditBase.ProcessNewValue event is fired. The DisplayValue property specifies the value entered converted to the type of the RepositoryItemLookUpEditBase.DisplayMember field.

If the value entered cannot be converted to this field type, however, then the DisplayValue property will contain the value entered as a string type.

Generally, you use the RepositoryItemLookUpEditBase.ProcessNewValue event in order to add a new row to the dropdown list. When adding a new row, you normally need to set its RepositoryItemLookUpEditBase.DisplayMember field value to DisplayValue. In this case, if you then set the ProcessNewValueEventArgs.Handled property to true, the editor will locate and retrieve the new record after performing your RepositoryItemLookUpEditBase.ProcessNewValue event handler.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DisplayValue 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-make-a-lookup-editor-function-as-a-regular-combobox-e2297/CS/MyDataSourceWrapper/MyGridLookupDataSourceHelper.cs#L57

{
    _MyObject.DisplayText = e.DisplayValue;
    this.popupOpened = false;

how-to-create-an-analog-of-gridlookupedit-with-treelist-in-a-popup-window-e4319/CS/Form1.cs#L164

    ID++;
    TreeList.AppendNode(new object[] { e.DisplayValue, "Little-Medium", ID }, null);
}

lookup-editors-combobox-mode-t378371/CS/Lookup-ComboboxMode/Form1.cs#L93

GridLookUpEdit gridLookup = sender as GridLookUpEdit;
if (e.DisplayValue == null) return;
string newValue = e.DisplayValue.ToString();

VB.NET

how-to-make-a-lookup-editor-function-as-a-regular-combobox-e2297/VB/MyDataSourceWrapper/MyGridLookupDataSourceHelper.vb#L53

Private Sub edit_ProcessNewValue(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.ProcessNewValueEventArgs)
    _MyObject.DisplayText = e.DisplayValue
    Me.popupOpened = False

how-to-create-an-analog-of-gridlookupedit-with-treelist-in-a-popup-window-e4319/VB/Form1.vb#L161

    Dim nullNode As TreeListNode = Nothing
    TreeList.AppendNode(New Object() {e.DisplayValue, "Little-Medium", ID}, nullNode)
End If

lookup-editors-combobox-mode-t378371/VB/Lookup-ComboboxMode/Form1.vb#L99

Dim gridLookup As GridLookUpEdit = TryCast(sender, GridLookUpEdit)
If e.DisplayValue Is Nothing Then
    Return