AutoCompleteBoxPropertiesBase.ValueField Property

Specifies the data source field that contains values for the editor’s items.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue("")]
public string ValueField { get; set; }

VB.NET

<DefaultValue("")>
Public Property ValueField As String

Property Value

Type	Default	Description
String	String.Empty	The data source field name.

Remarks

A data bound editor populates its Items collection by retrieving items from the specified data source and obtaining item characteristics (such as the item text, value or displayed image) from specific data fields. Use the ValueField property to specify a data source’s field from which the item values should be obtained.

If the ValueField property of a data bound combo box is not defined, the control can automatically obtain item values from a data field whose name is “Value”.

Important

The values contained in the ValueField field must be unique.

The ValueField property synchronizes its value with the editor’s ASPxAutoCompleteBoxBase.ValueField property.

Web Forms Example

Run Demo: ASPxComboBox - Cascading Combo Boxes

ASPX

<dx:ASPxComboBox runat="server" ID="CmbCountry" DropDownStyle="DropDownList" IncrementalFilteringMode="StartsWith"
    TextField="CountryName" ValueField="CountryName" Width="100%" DataSourceID="CountriesDataSource"
    EnableSynchronization="False">
    <ClientSideEvents SelectedIndexChanged="function(s, e) { OnCountryChanged(s); }" />
</dx:ASPxComboBox>

JS

var lastCountry = null;
function OnCountryChanged(cmbCountry) {
    if (cmbCity.InCallback())
        lastCountry = cmbCountry.GetValue().toString();
    else
        cmbCity.PerformCallback(cmbCountry.GetValue().toString());
    }
function OnEndCallback(s, e) {
    if (lastCountry) {
        cmbCity.PerformCallback(lastCountry);
        lastCountry = null;
    }
}

MVC Example

View Example: MVC ComboBox Extension - Cascading Combo Boxes

Razor (View)

@Html.DevExpress().ComboBox(settings => {
    settings.Name = "City";
    settings.Properties.TextField = "Name";
    settings.Properties.ValueField = "ID";
    ...
    settings.Properties.ClientSideEvents.BeginCallback = "function(s, e) { e.customArgs['Country'] = Country.GetValue(); }";
}).BindList(CS.Models.City.GetCities(Model.Country)).Bind(Model.City).GetHtml()
...
@Html.DevExpress().ComboBox(settings => {
    settings.Name = "Country";
    settings.Properties.TextField = "Name";
    settings.Properties.ValueField = "ID";
    ...
    settings.Properties.ClientSideEvents.SelectedIndexChanged = "function(s, e) { City.PerformCallback(); }";
}).BindList(CS.Models.Country.GetCountries()).Bind(Model.Country).GetHtml()  

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ValueField 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#

asp-net-mvc-grid-cascading-combo-boxes-in-batch-edit-mode/CS/Models/ComboBoxPropertiesProvider.cs#L72

cs.TextField = "CountryName";
cs.ValueField = "CountryId";
cs.ValueType = typeof(int);

asp-net-mvc-grid-cascading-combo-boxes-in-edit-form/CS/Models/ComboBoxPropertiesProvider.cs#L72

cs.TextField = "CountryName";
cs.ValueField = "CountryId";
cs.ValueType = typeof(int);

asp-net-mvc-grid-combobox-column-in-callback-mode/CS/Helpers/CallbackComboBoxHelper.cs#L15

p.CallbackRouteValues = new { Controller = "Home", Action = "CountryComboBox" };
p.ValueField = "CountryID";
p.TextField = "CountryName";

asp-net-web-forms-grid-bind-comboboxcolumn-edit-form-editor-at-runtime/CS/Solution/Default.aspx.cs#L15

comboColumn.PropertiesComboBox.TextField = "CategoryName";
comboColumn.PropertiesComboBox.ValueField = "CategoryID";
comboColumn.PropertiesComboBox.ValueType = typeof(Int32);

VB.NET

asp-net-mvc-grid-cascading-combo-boxes-in-batch-edit-mode/VB/Models/ComboBoxPropertiesProvider.vb#L65

cs.TextField = "CountryName"
cs.ValueField = "CountryId"
cs.ValueType = GetType(Integer)

asp-net-mvc-grid-cascading-combo-boxes-in-edit-form/VB/Models/ComboBoxPropertiesProvider.vb#L65

cs.TextField = "CountryName"
cs.ValueField = "CountryId"
cs.ValueType = GetType(Integer)

asp-net-mvc-grid-combobox-column-in-callback-mode/VB/Helpers/CallbackComboBoxHelper.vb#L18

p.CallbackRouteValues = New With {Key .Controller = "Home", Key .Action = "CountryComboBox"}
p.ValueField = "CountryID"
p.TextField = "CountryName"

asp-net-web-forms-grid-bind-comboboxcolumn-edit-form-editor-at-runtime/VB/Solution/Default.aspx.vb#L21

comboColumn.PropertiesComboBox.TextField = "CategoryName"
comboColumn.PropertiesComboBox.ValueField = "CategoryID"
comboColumn.PropertiesComboBox.ValueType = GetType(Integer)