ComboBoxItem.Value Property

Gets or sets the item value. This value is assigned to the editor’s edit value when users select the item.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

[DefaultValue(null)]
public virtual object Value { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Overridable Property Value As Object

Property Value

Type	Default	Description
Object	*null*	The item value.

Remarks

When you create items for an ImageComboBoxEdit editor, assign a unique value to each item through its Value property. For a ComboBoxEdit editor, there is no need to create ComboBoxItem object instances, as you may assign values directly to an editor:

C#

CheckedComboBoxEdit comboBox = new CheckedComboBoxEdit();
comboBox.Properties.Items.Add("Value 1");
comboBox.Properties.Items.AddRange(new object[] {"Value 2","Value 3" });

VB.NET

Dim comboBox As New CheckedComboBoxEdit()
comboBox.Properties.Items.Add("Value 1")
comboBox.Properties.Items.AddRange(New Object() {"Value 2","Value 3" })

The code sample below illustrates how to create an Image Combo Box with 3 values.

C#

ImageComboBoxEdit imageComboBox = new ImageComboBoxEdit();
imageComboBox.Bounds = new Rectangle(220, 10, 120, 20);
ImageCollection comboBoxImages = new ImageCollection();
comboBoxImages.AddImage(Image.FromFile(".\\photo1.png"));
comboBoxImages.AddImage(Image.FromFile(".\\photo2.png"));
comboBoxImages.AddImage(Image.FromFile(".\\photo3.png"));
imageComboBox.Properties.LargeImages = comboBoxImages;
for (int i = 0; i < comboBoxImages.Images.Count; i++)
    imageComboBox.Properties.Items.Add(new ImageComboBoxItem { Value = i+1, ImageIndex = i, Description = string.Format("Photo {0}",(i+1).ToString()) });
imageComboBox.SelectedIndexChanged += (o, e) =>
{
    ImageComboBoxEdit edit = o as ImageComboBoxEdit;
    XtraMessageBox.Show(string.Format("You have selected photo {0}",edit.EditValue.ToString()));
};
this.Controls.Add(imageComboBox);

VB.NET

Dim imageComboBox As New ImageComboBoxEdit()
imageComboBox.Bounds = New Rectangle(220, 10, 120, 20)
Dim comboBoxImages As New ImageCollection()
comboBoxImages.AddImage(Image.FromFile(".\photo1.png"))
comboBoxImages.AddImage(Image.FromFile(".\photo2.png"))
comboBoxImages.AddImage(Image.FromFile(".\photo3.png"))
imageComboBox.Properties.LargeImages = comboBoxImages
For i As Integer = 0 To comboBoxImages.Images.Count - 1
    imageComboBox.Properties.Items.Add(New ImageComboBoxItem With {.Value = i+1, .ImageIndex = i, .Description = String.Format("Photo {0}",(i+1).ToString())})
Next i
AddHandler imageComboBox.SelectedIndexChanged, Sub(o, e)
    Dim edit As ImageComboBoxEdit = TryCast(o, ImageComboBoxEdit)
    XtraMessageBox.Show(String.Format("You have selected photo {0}",edit.EditValue.ToString()))
End Sub
Me.Controls.Add(imageComboBox)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Value 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-custom-images-for-the-imagecomboboxedit-items-manually-in-code-e4414/CS/WindowsFormsApplication1/Form1.cs#L100

g.DrawRectangle(new Pen(Color.Black, 2), 0, 0, iWidth, iHeight);
HatchBrush b = new HatchBrush((HatchStyle)item.Value, Color.Black, Color.White);
g.FillRectangle(b, 0, 0, iWidth, iHeight);

how-to-manage-appointments-custom-fields-via-the-context-menu-e5159/CS/DXApplication5/CustomAppointmentForm.cs#L70

    if (AvailablePriorities.Count > 0 && priorityIndex < AvailablePriorities.Count)
        icbPriority.EditValue = icbPriority.Properties.Items[priorityIndex].Value;
}

VB.NET

how-to-create-custom-images-for-the-imagecomboboxedit-items-manually-in-code-e4414/VB/WindowsFormsApplication1/Form1.vb#L70

g.DrawRectangle(New Pen(Color.Black, 2), 0, 0, iWidth, iHeight)
g.FillRectangle(New SolidBrush(CType(item.Value, Color)), 1, 1, iWidth - 2, iHeight - 2)

how-to-manage-appointments-custom-fields-via-the-context-menu-e5159/VB/DXApplication5/CustomAppointmentForm.vb#L63

If AvailablePriorities.Count > 0 AndAlso priorityIndex < AvailablePriorities.Count Then
    icbPriority.EditValue = icbPriority.Properties.Items(priorityIndex).Value
End If