Click here to Skip to main content
15,940,246 members
Articles / Desktop Programming / WPF

WPF Auto-complete Control

Rate me:
Please Sign up or sign in to vote.
4.93/5 (16 votes)
14 Dec 2009CPOL1 min read 94.1K   6.6K   45   10
Implementing an auto-complete control in WPF by extending the ComboBox control.


There seems to be a lack of support for an auto-complete control in WPF. The closest one to it is the ComboBox which is the base of our implementation for this article.


An auto-complete control is one that allows the user to enter text while querying for a possible selection based on what the user has already entered. The most popular auto-complete implementation deals with querying of a "Starts With" of the current text in the control.

How it Works

Here are some of the properties we care about in the ComboBox:

  • IsEditable- This allows the user to input text into the control.
  • StaysOpenOnEdit - This will force the combobox to stay open when typing.
  • IsTextSearchEnabled - This uses the default "auto-complete" behavior of the ComboBox.

The Magic

By using a combination of the above properties (pretty self-explanatory) and a timer to control the delay of the query, an event which allows the user to attach a new data source, and some styles, we could implement an auto-complete control.

Using the Control


<Window x:Class="Gui.TestWindow"
      Title="Auto Complete Test" 
      Height="200" Width="300" 
              Source="/Gui.Controls;component/Styles/AutoComplete.Styles.xaml" />
        <ctr:AutoComplete x:Name="autoCities" 
           SelectedValuePath="CityID" DisplayMemberPath="Name" 
           Style="{StaticResource AutoCompleteComboBox}"
        <!-- can also do binding on selected value -->

Similar to a combo box, an auto-complete control utilizes the DisplayMemberPath and SelectValuePath properties to bind to a specific data source.


/// <summary>
/// occurs when the user stops typing after a delayed timespan
/// </summary>
/// <param name="sender"></param>
/// <param name="args"></param>
protected void autoCities_PatternChanged(object sender, 
          Gui.Controls.AutoComplete.AutoCompleteArgs args)
    if (string.IsNullOrEmpty(args.Pattern))
        args.CancelBinding = true;
        args.DataSource = TestWindow.GetCities(args.Pattern);

We can utilize the PatternChanged event to subscribe to changes to the the data source. This data source is also equal to a pattern the user has currently entered into the control.

Points of Interest

We utilize the MVVM pattern to create a ViewModel of any entity bound to the data source which contains the HighLight property. Through the use of styles, this highlighted section will be reflected in the dropdown.


  • Dec. 14, 2009 - Initial creation.


This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Written By
Canada Canada
Engineer, maker, food lover

Comments and Discussions

Questionusing in xceed datagrid control Pin
Piyush4Ever15-Apr-13 3:43
Piyush4Ever15-Apr-13 3:43 
QuestionHow to bind to data Pin
Frank Cazabon2-Jan-13 5:35
Frank Cazabon2-Jan-13 5:35 
QuestionPopulate with a value? Pin
nyland25-Jan-12 10:30
nyland25-Jan-12 10:30 
QuestionConverting to VB Pin
chj12424-Jun-11 8:19
chj12424-Jun-11 8:19 
GeneralMy vote of 5 Pin
njdnjdnjdnjdnjd9-May-11 22:44
njdnjdnjdnjdnjd9-May-11 22:44 
GeneralMy vote of 1 Pin
Volcano_881018-Nov-10 17:38
Volcano_881018-Nov-10 17:38 
GeneralGetting ItemsSource to work Pin
cjroebuck15-Dec-09 6:52
cjroebuck15-Dec-09 6:52 
GeneralRe: Getting ItemsSource to work Pin
Yang Yu15-Dec-09 7:29
Yang Yu15-Dec-09 7:29 
GeneralThanks a lot! Pin
Ratish Philip14-Dec-09 23:46
Ratish Philip14-Dec-09 23:46 
GeneralRe: Thanks a lot! Pin
Yang Yu15-Dec-09 11:06
Yang Yu15-Dec-09 11:06 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.