AutoCompleteBoxPropertiesBase.ValueField Property

Gets or sets the data source field that provides values for the editor’s items.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
String	String.Empty	A string value that specifies the name of the data source field from which the editor obtains item values.

Remarks

If a combobox editor is data bound (via the AutoCompleteBoxPropertiesBase.DataSourceID or AutoCompleteBoxPropertiesBase.DataSource property), the editor populates its AutoCompleteBoxPropertiesBase.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”.

Note

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

Example

The following example illustrates how to use the ValueField property.

WebForms approach:

Note

For a full example, see the ASPxComboBox - Cascading Combo Boxes demo.

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 approach:

Note

For a full example, refer to 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#

gridview-a-simple-implementation-of-cascading-comboboxes-in-batch-edit-mode-t155879/CS/Models/ComboBoxPropertiesProvider.cs#L72

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

gridview-how-to-implement-cascaded-combo-boxes-in-the-editform-e4425/CS/Models/ComboBoxPropertiesProvider.cs#L72

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

VB.NET

gridview-a-simple-implementation-of-cascading-comboboxes-in-batch-edit-mode-t155879/VB/Models/ComboBoxPropertiesProvider.vb#L65

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

gridview-how-to-implement-cascaded-combo-boxes-in-the-editform-e4425/VB/Models/ComboBoxPropertiesProvider.vb#L65

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