ListEditProperties.ValueField Property

Gets or sets the data source field that provides 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	A string value that specifies the name of the data source field from which the editor obtains item values.

Remarks

If a list editor is data bound (via the ListEditProperties.DataSourceID or ListEditProperties.DataSource property), the editor populates its ListEditProperties.Items collection by retrieving items from the specified data source and obtaining item characteristics (such item texts, values or displayed images) from specific data fields. Use the ValueField property to specify a data source’s field from which the item values should be obtained.

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

Note

An item’s value (ASPxListEdit.ValueField](xref:DevExpress.Web.ASPxListEdit.ValueField)) should be unique.

Example

ASPX

<dx:ASPxListBox ID="lbModels" SelectionMode="CheckColumn" EnableSelectAll="true" DataSourceID="PhoneModels" ValueField="ID" ValueType="System.String" ... >
     <CaptionSettings Position="Top" />
     <Columns>
          <dx:ListBoxColumn FieldName="Name" Caption="Model" Width="100%" />
          <dx:ListBoxColumn FieldName="Price" Width="50px" />
     </Columns>
</dx:ASPxListBox>
<asp:XmlDataSource ID="PhoneModels" DataFile="~/App_Data/PhoneModels.xml" XPath="//Model" runat="server" />

XML

<PhoneModels>
     <Model ID="1"  Name="Model1"  Price="$100" ... ></Model>
     <Model ID="2"  Name="Model2"  Price="$100" ... ></Model>
     <Model ID="3"  Name="Model3"  Price="$150" ... ></Model>
     <Model ID="4"  Name="Model4"  Price="$200" ... ></Model>
     <Model ID="5"  Name="Model5"  Price="$200" ... ></Model>
     ...
</PhoneModels>

For a full example, see List Box with Multiple Selection demo.