Please note that as of October 24, 2014, the Nokia Developer Wiki will no longer be accepting user contributions, including new entries, edits and comments, as we begin transitioning to our new home, in the Windows Phone Development Wiki. We plan to move over the majority of the existing entries over the next few weeks. Thanks for all your past and future contributions.

How to use Auto Complete Box in Windows Phone

From Wiki
Jump to: navigation, search

This article shows how to use AutoCompleteBox, a Windows Phone control that provides a text box for user input and a drop-down that contains possible matches based on the input in the text box.

WP Metro Icon UI.png
WP Metro Icon Tools.png
SignpostIcon XAML 40.png
WP Metro Icon WP8.png
SignpostIcon WP7 70px.png
Article Metadata
Code ExampleTested with
SDK: Windows Phone 8.0/7.1
Devices(s): Nokia Lumia 920, Nokia Lumia 800
Created: pooja_1650 (24 Jan 2012)
Updated: influencer (30 Oct 2012)
Reviewed: pooja_1650 (27 May 2013)
Last edited: vineet.jain (08 Aug 2013)

Ui AutoCompleteBoxTool.PNG



The AutoCompleteBox is defined in the Silverlight Toolkit, whose most recent version you can find here. If the toolkit is not installed already, please follow the installation instructions below.

Installing the Windows Phone Toolkit

For Windows Phone 8, you should try to install wptoolkit from NuGet.

  • Installation of the most recent Windows Phone Toolkit (formerly Silverlight toolkit) needs an installation of NuGet.
  • After NuGet is installed, the Toolkit has to be installed from the NuGet Package Manager Console in the Tools menu / Library Packge Manger submenu in Visual Studio.
  • Type "Install-Package SilverlightToolkitWP" there.

Tip.pngTip: The toolkit should be installed into your current solution. On my machine with a pre-installed older version (Oct 2011) of the toolkit I had problems. Removing the reference to the old assembly and finding the new one in the packages folder of the solution solved the problems on one machine but not on another...

Starting a New Project

  • Create a new project in Visual Studio 2010 from File>>New Project>>Windows Phone Application - Visual C#. Give a desired name of the project.

Creating a new Project in Windows Phone 7 using Visual C#

Using IEnumerable

  • We now need to make a class derived from IEnumerable interface. For this, right click the project in Project Explorer window: >>Add>>New Item>>Class (Here, we are using 'SampleWords' as our class name).
  • If we derive any class from IEnumerable interface, then it's compulsory to define the function GetEnumerator(). So, our class should look like below:
    namespace SampleAutoCompleteBox
    public class SampleWords : IEnumerable
    public IEnumerable AutoCompletions = new List<string>()
    "Lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing", "elit", "Nullam", "felis", "dui", "gravida", "at",
    "condimentum", "eget", "mattis", "non", "est", "Duis", "porta", "ornare", "tellus", "at", "convallis", "nibh", "aliquam",
    "faucibus", "Vivamus", "molestie", "fringilla", "ullamcorper", "Aenean", "non", "diam", "eu", "sapien", "pretium", "iaculis",
    "Quisque", "at", "ante", "libero", "eu", "tincidunt", "urna", "Cras", "libero", "ligula", "hendrerit", "at", "posuere", "at",
    "tempor", "at", "nulla", "Aliquam", "feugiat", "sagittis", "dolor", "convallis", "porttitor", "neque", "commodo", "ut", "Praesent",
    "egestas", "tincidunt", "lectus", "et", "pharetra", "enim", "semper", "et", "Fusce", "placerat", "orci", "vel", "iaculis",
    "dictum", "nulla", "sem", "convallis", "nunc", "in", "viverra", "leo", "mauris", "eu", "odio", "Nullam", "et", "ultricies",
    "sapien", "Proin", "quis", "mi", "a", "sapien", "semper", "lobortis", "ut", "eget", "est", "Suspendisse", "scelerisque", "porta",
    "mattis", "In", "eleifend", "tellus", "vel", "nulla", "aliquam", "ornare", "Praesent", "tincidunt", "dui", "ut", "libero",
    "iaculis", "consequat", "Nunc", "interdum", "eleifend", "rhoncus", "Curabitur", "sollicitudin", "nulla", "sagittis", "quam",
    "vehicula", "cursus", "Fusce", "laoreet", "arcu", "vitae", "fringilla", "scelerisque", "nisi", "purus", "laoreet", "ipsum", "id",
    "suscipit", "erat", "tellus", "eu", "sapien", "Proin", "pharetra", "tortor", "nisl", "Etiam", "et", "risus", "eget", "lectus",
    "vulputate", "dignissim", "ac","sed", "erat", "Nulla", "vel", "condimentum", "nunc", "Suspendisse", "aliquam", "euismod", "dictum",
    "Ut", "arcu", "enim", "consectetur", "at", "rhoncus", "at", "porta", "ut", "lacus", "Donec", "nisi", "quam", "faucibus", "tempor",
    "tincidunt", "eu", "porttitor", "id", "ipsum", "Proin", "nec", "neque", "nulla", "Suspendisse", "sapien", "metus", "aliquam", "nec",
    "dapibus", "consequat", "rutrum", "id", "leo", "Donec", "ac", "fermentum", "tortor", "Pellentesque", "nisl", "orci", "tincidunt",
    "at", "iaculis", "vitae", "consequat", "scelerisque", "ante", "Suspendisse", "potenti", "Maecenas", "auctor", "justo", "a", "nibh",
    "sagittis", "facilisis", "Phasellus", "ultrices", "lectus", "a", "nisl", "pretium", "accumsan"
    public IEnumerator GetEnumerator()
    return AutoCompletions.GetEnumerator();
  • Remember, not to forget adding the following 2 using directives
    using System.Collections; // for 'IEnumerable'
    using System.Collections.Generic; // for 'List'
  • Thus, we have declared a list of strings as our sample strings. Now to work on the UI.

Making UI and attaching Auto Complete Box with SampleWords class

  • We have to include the namespace inside which we have created the Strings class (SampleWords class according to this example) in the .xaml file in which we need to put AutoComplete box.
  • We will add below line of code in the MainPage.xaml (e.g)

The xmlns:local always point to the top level namespace. So, we have defined SampleWords.cs inside the SampleAutoCompleteBox namespace (same as your project name).

  • Create/declare a static resource in the MainPage.xaml file like shown below
x:Key="AutoCompletions" />

Here, local: will have the class file name in which we have declared the list of stings. We have also defined a key as AutoCompletions so that it can be directly used by it in future.

  • Now we will drag and drop the AutoCompleteBox tool from the Toolkit on to the MainPage.xaml design view. By this, the corresponding code will be inserted into the code view.
  • We will assign the value StaticResource AutoCompletions to the property ItemsSource as shown below:
    <Grid x:Name="ContentPanel" Grid.Row="1" Margin="12,0,12,0">
    <toolkit:AutoCompleteBox HorizontalAlignment="Left" Width="450" Grid.Row="0"
    Name="autoCompleteBox1" VerticalAlignment="Top"
    ItemsSource="{StaticResource AutoCompletions}"/>
  • Now build the project and run it to see AutoCompleteBox tool running.

Tip.pngTip: If you want to open Integer keyboard rather than strings (the default), simply use the property InputScope as shown below.

  • <Grid x:Name="ContentPanel" Grid.Row="1" Margin="12,0,12,0">
    <toolkit:AutoCompleteBox HorizontalAlignment="Left" Width="450" Grid.Row="0"
    Name="autoCompleteBox1" VerticalAlignment="Top" InputScope="Digits"
    ItemsSource="{StaticResource AutoCompletions}"/>

Tip.pngTip: If you want to set maximum characters length for the Auto Complete Box then use the following code.

  • <toolkit:AutoCompleteBox>
    <Style TargetType="TextBox">
    <Setter Property="MaxLength" Value="10"/>

Source code

  • The example illustrated in the article can be downloaded from here .
This page was last modified on 8 August 2013, at 16:28.
937 page views in the last 30 days.

Was this page helpful?

Your feedback about this content is important. Let us know what you think.


Thank you!

We appreciate your feedback.