AutoCompleteEdit.ItemsSourceProvider Property

Gets or sets the data provider that supplies suggestions.

Namespace: DevExpress.XamarinForms.Editors

Assembly: DevExpress.XamarinForms.Editors.dll

NuGet Package: DevExpress.XamarinForms.Editors

Declaration

public ItemsSourceProviderBase ItemsSourceProvider { get; set; }

Property Value

Type	Description
ItemsSourceProviderBase	A data provider that supplies suggestions.

Examples

The example below uses the AsyncItemsSourceProvider to supply suggestions for the AutoCompleteEdit.

XAML

<dxe:AutoCompleteEdit
    LabelText="State"
    PlaceholderText="Type here to search..."
    VerticalOptions="Center"
    Margin="16,0">

    <dxe:AutoCompleteEdit.ItemsSourceProvider>
        <dxe:AsyncItemsSourceProvider SuggestionsRequested="OnDelegateRequested" />
    </dxe:AutoCompleteEdit.ItemsSourceProvider>
</dxe:AutoCompleteEdit>

C#

using System.Collections.Generic;
using System.ComponentModel;
using Xamarin.Forms;

namespace AutoCompleteEditExample {
    public partial class MainPage : ContentPage {
        public MainPage() {
            InitializeComponent();
            States = new List<string>();
            States.AddRange(new string[] { "California", "Colorado", "Connecticut" /*...*/ });
        }
        public List<string> States { get; }
        void OnDelegateRequested(object sender, SuggestionsRequestEventArgs e) {
            e.Request = () => {
                return States.Where(i => i.StartsWith(e.Text, StringComparison.CurrentCultureIgnoreCase)).ToList();
            };
        }
    }
}

The example below uses the FilteredItemsSourceProvider to supply suggestions for the AutoCompleteEdit.

XAML

<ContentPage.BindingContext>
    <local:AutoCompleteEditViewModel/>
</ContentPage.BindingContext>

<dxe:AutoCompleteEdit>
    <dxe:AutoCompleteEdit.ItemsSourceProvider>
        <dxe:FilteredItemsSourceProvider SuggestionsSource="{Binding ItemsSource}"
                                         FilterMode="Contains"
                                         FilterComparisonType="CurrentCultureIgnoreCase"
                                         FilterMembers="Name, Capital"/>
    </dxe:AutoCompleteEdit.ItemsSourceProvider>

    <dxe:AutoCompleteEdit.ItemTemplate>
        <DataTemplate>
            <Grid>
                <Label Padding="10" Text="{Binding Name}" FontAttributes="Bold"/>
                <Label Padding="10" Grid.Column="1" Text="{Binding Abbr}"/>
                <Label Padding="10" Grid.Column="2" Text="{Binding Capital}" HorizontalTextAlignment="End"/>
            </Grid>
        </DataTemplate>
    </dxe:AutoCompleteEdit.ItemTemplate>
</dxe:AutoCompleteEdit>

C#

using System.Collections.Generic;
using System.ComponentModel;
using Xamarin.Forms;

namespace AutoCompleteEditExample {
    public partial class MainPage : ContentPage {
        public MainPage() {
            InitializeComponent();
        }
    }

    public class State {
        public string Name { get; set; }
        public string Abbr { get; set; }
        public string Capital { get; set; }
    }

    public class AutoCompleteEditViewModel : INotifyPropertyChanged {

        List<State> itemsSource = new List<State>();

        public List<State> ItemsSource { get { return itemsSource; } set { itemsSource = value; OnPropertyChanged(nameof(ItemsSource)); } }

        public AutoCompleteEditViewModel() {
            ItemsSource.Add(new State() { Name = "California", Abbr = "CA", Capital = "Sacramento" });
            ItemsSource.Add(new State() { Name = "Colorado", Abbr = "CO", Capital = "Denver" });
            ItemsSource.Add(new State() { Name = "Connecticut", Abbr = "CT", Capital = "Hartford" });            
        }

        public event PropertyChangedEventHandler PropertyChanged;
        protected void OnPropertyChanged(string propertyName) {
            PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
        }
    }
}