ComboBoxEdit Class

A combobox editor.

Namespace: DevExpress.Xpf.Editors

Assembly: DevExpress.Xpf.Core.v20.1.dll

Declaration

public class ComboBoxEdit :
    LookUpEditBase,
    ISelectorEdit,
    IBaseEdit,
    IInputElement
Public Class ComboBoxEdit
    Inherits LookUpEditBase
    Implements ISelectorEdit,
               IBaseEdit,
               IInputElement

Related API Members

The following members accept/return ComboBoxEdit objects:

Remarks

TIP

The ComboBoxEdit class inherits its features from the LookUpEditBase class.

Refer to the LookUpEditBase class description for information on derived features and API.

Create a ComboBoxEdit

Use the ComboBoxEdit.Items property to add items. This property is marked with the ContentPropertyAttribute attribute, so in XAML you can add elements to the group between the start and end ComboBoxEdit tags.

<Window ...
    xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors">

<dxe:ComboBoxEdit>
    <dxe:ComboBoxEditItem>Item1</dxe:ComboBoxEditItem>
    <dxe:ComboBoxEditItem>Item2</dxe:ComboBoxEditItem>
    <dxe:ComboBoxEditItem>Item3</dxe:ComboBoxEditItem>
</dxe:ComboBoxEdit>
...

Bind to Data

Use the ItemsSource property to bind the ComboBoxEdit to an IEnumerable source.

Bind to a List of Simple Objects

<dxe:ComboBoxEdit ItemsSource="{Binding}"/> 
using System;
using System.Collections.Generic;
using System.Windows;

namespace ComboBoxSample {
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            this.DataContext = new List<string>(){"Item 1", "Item 2", "Item 3"};
        }
    }
} 

Bind to a Collection of Objects (Lookup Mode)

To bind the ComboBoxEdit to a collection of objects, use the DisplayMember and ValueMember properties.

The DisplayMember property specifies a source field name whose values are used as item display text.

The ValueMember property specifies a source field name whose values are used as actual item values. If this property is not specified, the ComboBoxEdit returns a source object itself.

<dxe:ComboBoxEdit 
    ItemsSource="{Binding}" 
    DisplayMember="Name"
    ValueMember="Id"/> 
using System;
using System.Collections.Generic;

namespace ComboBoxSample {
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            this.DataContext = new List<Customer>(){
                new Customer(){ Id = 1, Name = "Gregory S. Price" },
                new Customer(){ Id = 2, Name = "Irma R. Marshall" },
                new Customer(){ Id = 3, Name = "John C. Powell" }
            };
        }
    }
    public class Customer {
        public int Id { get; set; }
        public string Name { get; set; }
    }
} 
NOTE

When the DisplayMember and ValueMember properties are specified, the ComboBoxEdit allows users to enter only the values from its ItemsSource.

Bind to Enumeration Values

You can bind the ComboBoxEdit to enumeration values in any of the following ways:

Edit Value and Display Text

The ComboBoxEdit value is specified by the EditValue property. To respond to edit value changing, handle the BaseEdit.EditValueChanging and BaseEdit.EditValueChanged events.

The DisplayText property returns the text displayed in the ComboBoxEdit.

Edit Value in Multiselect Mode

If an editor works in checked, token, or checked token mode, it allows end users to select multiple data items at once. In this case, the editor's EditValue property returns a list of Objects. You can cast these objects to:

ComboBoxEdit Operation Modes

The ComboBoxEdit supports the following operation modes:

  • default
  • checked
  • radio
  • token
  • checked token

To specify a mode, set the StyleSettings property to the corresponding mode object.

Combobox (Default)

The mode object: ComboBoxStyleSettings.

ComboBoxEditStyleSettingsDefault

<dxe:ComboBoxEdit ItemsSource="{Binding Customers}">
    <dxe:ComboBoxEdit.StyleSettings>
        <dxe:ComboBoxStyleSettings />
    </dxe:ComboBoxEdit.StyleSettings>
</dxe:ComboBoxEdit>

Checked Combobox

The mode object: CheckedComboBoxStyleSettings.

ComboBoxEditStyleSettingsChecked

<dxe:ComboBoxEdit ItemsSource="{Binding Customers}">
    <dxe:ComboBoxEdit.StyleSettings>
        <dxe:CheckedComboBoxStyleSettings />
    </dxe:ComboBoxEdit.StyleSettings>
</dxe:ComboBoxEdit> 

Radio Button Combobox

The mode object: RadioComboBoxStyleSettings.

ComboBoxEditStyleSettingsRadio

<dxe:ComboBoxEdit ItemsSource="{Binding Cities}">
    <dxe:ComboBoxEdit.StyleSettings>
        <dxe:RadioComboBoxStyleSettings />
    </dxe:ComboBoxEdit.StyleSettings>
</dxe:ComboBoxEdit>

Token Combobox

The mode object: TokenComboBoxStyleSettings.

ComboBoxEditStyleSettingsToken

<dxe:ComboBoxEdit ItemsSource="{Binding Cities}">
    <dxe:ComboBoxEdit.StyleSettings>
        <dxe:TokenComboBoxStyleSettings />
    </dxe:ComboBoxEdit.StyleSettings>
</dxe:ComboBoxEdit>

Checked Token Combobox

The mode object: CheckedTokenComboBoxStyleSettings.

ComboBoxEditStyleSettingsCheckedToken

<dxe:ComboBoxEdit ItemsSource="{Binding Cities}">
    <dxe:ComboBoxEdit.StyleSettings>
        <dxe:CheckedTokenComboBoxStyleSettings />
    </dxe:ComboBoxEdit.StyleSettings>
</dxe:ComboBoxEdit>

Auto Complete

The ComboBoxEdit can automatically complete the text typed by a user to a valid value. To enable automatic completion, set the AutoComplete property to true.

<dxe:ComboBoxEdit 
                 AutoComplete="True" 
                 ItemsSource="{Binding Cities}" />

In the auto complete mode, the ComboBoxEdit can highlight the item in the dropdown that matches the user input. To enable item highlighting, set the LookUpEditBase.IncrementalSearch property to true.

<dxe:ComboBoxEdit 
    AutoComplete="True"
    IncrementalSearch="True"
    ImmediatePopup="True"
    ItemsSource="{Binding Cities}" />

Incremental Filtering

The ComboBoxEdit can filter items on user input. To enable incremental filtering, set the IncrementalFiltering property to true. To enable case-sensitive filtering, set the LookUpEditBase.IsCaseSensitiveFilter property to true.

<dxe:ComboBoxEdit 
                 IncrementalFiltering="True" 
                 ItemsSource="{Binding Countries}" />
TIP

Demo: ComboBoxEdit

Requires installation of WPF Subscription. Download

See Also