ComboBoxEdit.SelectedItem Property

Specifies the editor’s value.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[Browsable(false)]
public virtual object SelectedItem { get; set; }

VB.NET

<Browsable(False)>
Public Overridable Property SelectedItem As Object

Property Value

Type	Description
Object	The editor’s value.

Remarks

When you select an item from the dropdown, a corresponding object from the item collection is automatically assigned to SelectedItem. In addition, entering a value in the edit box changes the SelectedItem.

The SelectedItem property matches the value of the ComboBoxEdit.EditValue property. The difference between them is that you can set ComboBoxEdit.EditValue to any object, while SelectedItem can be set only to an element of the RepositoryItemComboBox.Items collection.

The ComboBoxEdit.SelectedIndex property returns the index of the SelectedItem value in the RepositoryItemComboBox.Items collection. This allows you to know whether the current editor’s value is from the dropdown list or arbitrary data.

Note: to ensure proper functionality of the editor, items in the RepositoryItemComboBox.Items collection must be unique objects.

The code sample below illustrates how to use a combo box to specify the data source for a grid.

C#

xmlDataSet = new System.Data.DataSet("XML DataSet");
xmlDataSet.ReadXml(@".\\transportation.xml");
comboBoxEdit1.Properties.Items.AddRange(new string[] { "Drivers", "Vehicles", "Products" });

private void comboBoxEdit1_SelectedIndexChanged(object sender, EventArgs e)
{
    var combo = sender as ComboBoxEdit;
    gridControl1.DataSource = xmlDataSet.Tables[combo.SelectedItem.ToString()];

}

VB.NET

xmlDataSet = New System.Data.DataSet("XML DataSet")
xmlDataSet.ReadXml(".\\transportation.xml")
comboBoxEdit1.Properties.Items.AddRange(New String() { "Drivers", "Vehicles", "Products" })

private void comboBoxEdit1_SelectedIndexChanged(Object sender, EventArgs e)
    Dim combo = TryCast(sender, ComboBoxEdit)
    gridControl1.DataSource = xmlDataSet.Tables(combo.SelectedItem.ToString())

Related GitHub Examples

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

winforms-map-calculate-routes-from-major-roads/CS/CalculateRoutesFromMajorRoads/Form1.cs#L64

private void OnTravelModeSelectedIndexChanged(object sender, EventArgs e) {
    routeProvider.RouteOptions.Mode = (BingTravelMode)cbeTravelMode.SelectedItem;
}

how-to-use-automatic-date-time-scale-modes-of-an-axis-e1531/CS/DateTimeAggregation/Form1.cs#L243

void ExecuteSelectedItemAction(ComboBoxEdit comboBox) {
    ComboBoxItem item = comboBox.SelectedItem as ComboBoxItem;
    if (item != null) {

winforms-scheduler-sync-with-google-calendars/CS/GCSync/Form1.cs#L53

ComboBoxEdit edit = (ComboBoxEdit)sender;
string selectedCalendarSummary = (string)edit.SelectedItem;
CalendarListEntry selectedCalendar = this.calendarList.Items.FirstOrDefault(x => x.Summary == selectedCalendarSummary);

VB.NET

winforms-map-calculate-routes-from-major-roads/VB/CalculateRoutesFromMajorRoads/Form1.vb#L70

Private Sub OnTravelModeSelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
    routeProvider.RouteOptions.Mode = CType(cbeTravelMode.SelectedItem, BingTravelMode)
End Sub

how-to-use-automatic-date-time-scale-modes-of-an-axis-e1531/VB/DateTimeAggregation/Form1.vb#L249

Private Sub ExecuteSelectedItemAction(ByVal comboBox As ComboBoxEdit)
    Dim item As ComboBoxItem = TryCast(comboBox.SelectedItem, ComboBoxItem)
    If item IsNot Nothing Then

winforms-scheduler-sync-with-google-calendars/VB/GCSync/Form1.vb#L56

Dim edit As ComboBoxEdit = CType(sender, ComboBoxEdit)
Dim selectedCalendarSummary As String = CStr(edit.SelectedItem)
Dim selectedCalendar As CalendarListEntry = calendarList.Items.FirstOrDefault(Function(x) Equals(x.Summary, selectedCalendarSummary))