DxComboBox<TData, TValue>.ValueFieldName Property

Specifies the data source field that populates values for the ComboBox’s items.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v21.1.dll

Declaration

[Parameter]
public string ValueFieldName { get; set; }

Property Value

Type Description
String

The field name.

Remarks

If a ComboBox is bound to a field that stores IDs or other non-user-friendly values, you may want to use lookup functionality. You can replace IDs with human-readable strings and let users select values from a lookup list.

For example, the following image shows how lookup functionality is used for the Employee.ID field of the Employees data source object. The component finds the IDs from a different collection and replaces them with the corresponding DisplayText values.

ComboBox Value Field Scheme

Use the ValueFieldName property to specify a data source field to obtain item values from. To access the editor’s selected value, use the Value property.

NOTE

If the ValueFieldName property is not specified and TValue and TData are different, the ComboBox component searches for a Value field in the data source. If the field is found and its type matches TValue, the component uses this field as a value field.

<DxComboBox Data="@Employees.DataSource"
            ValueFieldName="@nameof(Employee.ID)"
            TextFieldName="@nameof(Employee.DisplayText)"
            @bind-Value="@Value">
</DxComboBox>

@code {
    int Value { get; set; } = 1;
}

Run Demo: ComboBox - Item Values

See Also