BaseListBoxControl.ValueMember Property

Gets or sets the field name in the bound data source whose contents are assigned to item values.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

[DefaultValue("")]
[DXCategory("Data")]
public virtual string ValueMember { get; set; }

VB.NET

<DefaultValue("")>
<DXCategory("Data")>
Public Overridable Property ValueMember As String

Property Value

Type	Default	Description
String	String.Empty	A string value specifying a field name in the data source.

Remarks

This property is in effect when a list box control is bound to a data source via the BaseListBoxControl.DataSource property.

You can optionally specify the ValueMember property for your own purposes. For instance, you can specify this property in order to subsequently get this field’s values for list box items via the BaseListBoxControl.GetItemValue method.

Values of the field specified by the ValueMember property are never displayed.

To specify the field whose values are displayed in the list box control, use the BaseListBoxControl.DisplayMember property.

Changing the ValueMember property value at runtime raises the BaseListBoxControl.ValueMemberChanged event.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ValueMember 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-create-a-popupcontaineredit-control-with-a-checkedlistboxcontrol-in-the-popuform-e4688/CS/NewProject/PopupContainerEditHelper.cs#L74

{
    return CheckedListBox.ValueMember;
}

how-to-drag-drop-listboxcontrol-items-between-listboxcontrols-bound-mode-e2475/CS/Form1.cs#L128

listBoxControl1.DataSource = t1;
listBoxControl1.ValueMember = "ID";
listBoxControl1.DisplayMember = "Data";

how-to-implement-a-custom-imagecombobox-editor-that-allows-entering-custom-values-e2435/CS/DXSample/MyPopupContainerEdit.cs#L69

public string ValueMember {
    get { return imageListBox.ValueMember; }
    set {

how-to-implement-the-insert-document-field-dialog-winforms-version-t223036/CS/WindowsFormsApplication1/InsertFieldModules/ucPAGENUMBER.cs#L43

    listBoxControlAttributes.DisplayMember = "DisplayName";
    listBoxControlAttributes.ValueMember = "AttributeValue";
}

how-to-implement-a-radio-list-control-e3152/CS/WindowsApplication1/Form1.cs#L33

    myRadioListBox1.DisplayMember = "Name";
    myRadioListBox1.ValueMember = "ID";
}

VB.NET

how-to-implement-the-insert-document-field-dialog-winforms-version-t223036/VB/WindowsFormsApplication1/InsertFieldModules/ucCREATEDATE.vb#L31

    listBoxControlFormats.DisplayMember = "DisplayName"
    listBoxControlFormats.ValueMember = "AttributeValue"
End Sub

how-to-create-a-popupcontaineredit-control-with-a-checkedlistboxcontrol-in-the-popuform-e4688/VB/NewProject/PopupContainerEditHelper.vb#L72

Get
    Return CheckedListBox.ValueMember
End Get

how-to-drag-drop-listboxcontrol-items-between-listboxcontrols-bound-mode-e2475/VB/Form1.vb#L123

listBoxControl1.DataSource = t1
listBoxControl1.ValueMember = "ID"
listBoxControl1.DisplayMember = "Data"

how-to-implement-a-custom-imagecombobox-editor-that-allows-entering-custom-values-e2435/VB/DXSample/MyPopupContainerEdit.vb#L72

Get
    Return imageListBox.ValueMember
End Get

how-to-implement-a-radio-list-control-e3152/VB/WindowsApplication1/Form1.vb#L32

    myRadioListBox1.DisplayMember = "Name"
    myRadioListBox1.ValueMember = "ID"
End Sub