Data binding in ASP.NET CORE AutoComplete Control

7 Jun 202423 minutes to read

The AutoComplete loads the data either from local data sources or remote data services using the dataSource property. It supports the data type of array or DataManager.

The AutoComplete also supports different kind of data services such as OData, OData V4, Web API and data formats such as XML, JSON, JSONP with the help of DataManager Adaptors.

Fields	Type	Description
value	number or string	Specifies the hidden data value mapped to each list item that should contain a unique value.
groupBy	string	Specifies the category under which the list item has to be grouped.
iconCss	string	Specifies the icon class of each list item.

NOTE

While binding complex data to AutoComplete, fields should be mapped correctly. Otherwise, the selected item remains undefined.

Bind to local data

Local data can be represented in two ways as described below.

Array of string

The AutoComplete has support to load array of primitive data such as strings and numbers.

CSHTML

@{
    ....
    var data = new string[] { "Badminton", "Basketball", "Cricket", "Football", "Golf", "Gymnastics", "Hockey", "Tennis" };
}

<div class="control-wrapper">
    <div id="default" style='padding-top:75px;margin:0 auto;width:250px;'>
        <ejs-autocomplete id="games" dataSource="@data" placeholder="e.g. Basketball" popupHeight="220px">
        </ejs-autocomplete>
    </div>
</div>

Array of object

The AutoComplete can generate its list items through an array of complex data. For this, the appropriate columns should be mapped to the fields property.

In the following example, Name column from complex data have been mapped to the value field.

CSHTML

@{
    List<Countries> country = new List<Countries>();
    country.Add(new Countries { Name = "Australia", Code = "AU" });
    country.Add(new Countries { Name = "Bermuda", Code = "BM" });
    country.Add(new Countries { Name = "Canada", Code = "CA" });
    country.Add(new Countries { Name = "Cameroon", Code = "CM" });
    country.Add(new Countries { Name = "Denmark", Code = "DK" });
    country.Add(new Countries { Name = "France", Code = "FR" });
    country.Add(new Countries { Name = "Finland", Code = "FI" });
    country.Add(new Countries { Name = "Germany", Code = "DE" });
    country.Add(new Countries { Name = "Greenland", Code = "GL" });
    country.Add(new Countries { Name = "Hong Kong", Code = "HK" });
    country.Add(new Countries { Name = "India", Code = "IN" });
    country.Add(new Countries { Name = "Italy", Code = "IT" });
    country.Add(new Countries { Name = "Japan", Code = "JP" });
    country.Add(new Countries { Name = "Mexico", Code = "MX" });
    country.Add(new Countries { Name = "Norway", Code = "NO" });
    country.Add(new Countries { Name = "Poland", Code = "PL" });
    country.Add(new Countries { Name = "Switzerland", Code = "CH" });
    country.Add(new Countries { Name = "United Kingdom", Code = "GB" });
    country.Add(new Countries { Name = "United States", Code = "US" });
}

<div class="control-wrapper">
    <div id="default" style='padding-top:75px;margin:0 auto;width:250px;'>
        <ejs-autocomplete id="country" dataSource="@country" placeholder="e.g. india" index="2" popupheight="220px">
            <e-autocomplete-fields value="Name" ></e-autocomplete-fields>
        </ejs-autocomplete>
    </div>
</div>

CSHTML.cs

public class Countries
{
    public string Name { get; set; }
    public string Code { get; set; }
}

Array of complex object

The AutoComplete can generate its list items through an array of complex data. For this, the appropriate columns should be mapped to the fields property.

In the following example, Country.CountryId column from complex data have been mapped to the value field.

CSHTML

@{
    List<Complex> data = new List<Complex>();
    data.Add(new Complex() { Country = new Country() { CountryId = "Australia"  }, Code = new Code() { Id = "AU" } });
    data.Add(new Complex() { Country = new Country() { CountryId = "Bermuda" }, Code = new Code() { Id = "BM" } });
    data.Add(new Complex() { Country = new Country() { CountryId = "Canada" }, Code = new Code() { Id = "CA" } });
    data.Add(new Complex() { Country = new Country() { CountryId = "Cameroon" }, Code = new Code() { Id = "CM" } });
    data.Add(new Complex() { Country = new Country() { CountryId = "Denmark" }, Code = new Code() { Id = "DK" } });
    data.Add(new Complex() { Country = new Country() { CountryId = "France" }, Code = new Code() { Id = "FR" } });
}

<div class="control-wrapper">
    <div id="default" style='padding-top:75px;margin:0 auto;width:250px;'>
        <ejs-autocomplete id="country" datasource="@data" placeholder="Select a Country" popupheight="220px">
            <e-autocomplete-fields value="Country.CountryId"></e-autocomplete-fields>
        </ejs-autocomplete>
    </div>
</div>

CSHTML.cs

public class Code
{
    public string Id { get; set; }
}
public class Country
{
    public string CountryId { get; set; }
}
public class Complex
{
    public Country Country { get; set; }
    public Code Code { get; set; }
}

Bind to remote data

The AutoComplete supports retrieval of data from remote data services with the help of DataManager control. The Query property is used to fetch data from the database and bind it to the AutoComplete.

The following sample displays the first 6 contacts from the Customers table of the Northwind data service.

CSHTML

<div id='remote-data' class='col-lg-6' style='padding-top:15px'>
    <div class='content'>
        <ejs-autocomplete id="customers" query="new ej.data.Query().from('Customers').select(['ContactName', 'CustomerID']).take(6)" placeholder="Select a customer" popupHeight="200px">
            <e-autocomplete-fields value="ContactName"></e-autocomplete-fields>
            <e-data-manager url="https://services.odata.org/V4/Northwind/Northwind.svc/" adaptor="ODataV4Adaptor" crossDomain="true"></e-data-manager>
        </ejs-autocomplete>
    </div>
</div>

Bind to URL Adaptor

The AutoComplete supports retrieval of data from URL adaptor.

CSHTML

<div id='url-data' class='col-lg-6' style='padding-top:15px'>
    <div class='content'>
        <ejs-autocomplete id="country" placeholder="Select a Country">
            <e-data-manager adaptor="UrlAdaptor" url="/AutoComplete/UrlDatasource" crossDomain="true"></e-data-manager>
            <e-autocomplete-fields value="ShipCountry"></e-autocomplete-fields>
        </ejs-autocomplete>
    </div>
</div>

Urldata.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using System.Web.Mvc;
using WebApplication1.Models;

namespace WebApplication1.Controllers
{
    public class AutoCompleteController : Controller
    {
         public ActionResult Index()
        {
            return View();
        }
        public ActionResult UrlDatasource([FromBody]Data dm)
        {
            var val = OrdersDetails.GetAllRecords();
            var Data = val.ToList();
            var count = val.Count();
            if (dm.where != null)
            {
                Data = (from cust in Data
                        where cust.ShipCountry.ToLower().StartsWith(dm.@where[0].value.ToString())
                        select cust).ToList();
            }
            if (dm.take != 0)
                Data = Data.Take(dm.take).ToList();
            return Json(Data);
        }


        public class Data
        {
            public int take { get; set; }
            public List<Wheres> where { get; set; }
        }

        public class Wheres
        {
            public string field { get; set; }
            public bool ignoreAccent { get; set; }

            public bool ignoreCase { get; set; }

            public bool isComplex { get; set; }

            public string value { get; set; }
            public string Operator { get; set; }

        }
        public class OrdersDetails
        {
            public static List<OrdersDetails> order = new List<OrdersDetails>();
            public OrdersDetails()
            {

            }
            public OrdersDetails(int OrderID, string CustomerId, int EmployeeId, double Freight, bool Verified, DateTime OrderDate, string ShipCity, string ShipName, string ShipCountry, DateTime ShippedDate, string ShipAddress)
            {
                this.OrderID = OrderID;
                this.CustomerID = CustomerId;
                this.EmployeeID = EmployeeId;
                this.Freight = Freight;
                this.ShipCity = ShipCity;
                this.Verified = Verified;
                this.OrderDate = OrderDate;
                this.ShipName = ShipName;
                this.ShipCountry = ShipCountry;
                this.ShippedDate = ShippedDate;
                this.ShipAddress = ShipAddress;
            }
            public static List<OrdersDetails> GetAllRecords()
            {
                if (order.Count() == 0)
                {
                    int code = 10000;
                    for (int i = 1; i < 10; i++)
                    {
                        order.Add(new OrdersDetails(code + 1, "ALFKI", i + 0, 2.3 * i, false, new DateTime(1991, 05, 15), "Berlin", "Simons bistro", "Denmark", new DateTime(1996, 7, 16), "Kirchgasse 6"));
                        order.Add(new OrdersDetails(code + 2, "ANATR", i + 2, 3.3 * i, true, new DateTime(1990, 04, 04), "Madrid", "Queen Cozinha", "Brazil", new DateTime(1996, 9, 11), "Avda. Azteca 123"));
                        order.Add(new OrdersDetails(code + 3, "ANTON", i + 1, 4.3 * i, true, new DateTime(1957, 11, 30), "Cholchester", "Frankenversand", "Germany", new DateTime(1996, 10, 7), "Carrera 52 con Ave. Bolívar #65-98 Llano Largo"));
                        order.Add(new OrdersDetails(code + 4, "BLONP", i + 3, 5.3 * i, false, new DateTime(1930, 10, 22), "Marseille", "Ernst Handel", "Austria", new DateTime(1996, 12, 30), "Magazinweg 7"));
                        order.Add(new OrdersDetails(code + 5, "BOLID", i + 4, 6.3 * i, true, new DateTime(1953, 02, 18), "Tsawassen", "Hanari Carnes", "Switzerland", new DateTime(1997, 12, 3), "1029 - 12th Ave. S."));
                        code += 5;
                    }
                }
                return order;
            }

            public int? OrderID { get; set; }
            public string CustomerID { get; set; }
            public int? EmployeeID { get; set; }
            public double? Freight { get; set; }
            public string ShipCity { get; set; }
            public bool Verified { get; set; }
            public DateTime OrderDate { get; set; }

            public string ShipName { get; set; }

            public string ShipCountry { get; set; }

            public DateTime ShippedDate { get; set; }
            public string ShipAddress { get; set; }
        }
    }
}

Web API Adaptor

Use the WebApiAdaptor to bind autocomplete with Web API created using OData.

CSHTML

<div id='web-data' class='col-lg-6' style='padding-top:15px'>
    <div class='content'>
        <ejs-autocomplete id="games">
            <e-data-manager url="/api/AutoComplete/" adaptor="WebApiAdaptor"></e-data-manager>
        </ejs-autocomplete>
    </div>
</div>

Webapi.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using WebApplication1.Models;

namespace WebApplication1.Controllers
{
    [Route("api/[controller]")]
    public class AutoCompleteController : Controller
    {
        List<string> game = new List<string>();
        [HttpGet]
        public List<string> Get()
        {
            game.Add("Badminton");
            game.Add("Basketball");
            game.Add("Cricket");
            game.Add("Golf");
            game.Add("Gymnastics");
            game.Add("Tennis");
            game.Add("Hockey");
            return game;
        }
    }
}

Binding with OData services

OData is a standardized protocol for creating and consuming data. You can retrieve data from OData service using the DataManager.

The following example for remote data binding using OData service.

CSHTML

<div id='remote-data' class='col-lg-6' style='padding-top:15px'>
    <div class='content'>
        <ejs-autocomplete id="customers" placeholder="Select a customer" query="new ej.data.Query().select(['CustomerID']).take(7)">
            <e-autocomplete-fields value="CustomerID"></e-autocomplete-fields>
            <e-data-manager url="https://js.syncfusion.com/ejServices/Wcf/Northwind.svc/Orders/" adaptor="ODataAdaptor" crossDomain="true"></e-data-manager>
        </ejs-autocomplete>
    </div>
</div>

Odata.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using System.Web.Mvc;

namespace WebApplication1.Controllers
{
   public class AutoCompleteController : Controller
    {
        public ActionResult Index()
        {
            return View();
        }
   
    }
}

Offline mode

To avoid post back for every action, set the autocomplete to load all data on initialization and make the actions process in client-side. To enable this behavior, use the Offline property of DataManager.

CSHTML

<div id='remote-data' class='col-lg-6' style='padding-top:15px'>
    <div class='content'>
        <ejs-autocomplete id="customers" placeholder="Select a customer" query="new ej.data.Query().select(['CustomerID']).take(7)">
            <e-autocomplete-fields value="CustomerID"></e-autocomplete-fields>
            <e-data-manager url="https://js.syncfusion.com/ejServices/Wcf/Northwind.svc/Orders/" adaptor="ODataAdaptor" offline="true" crossDomain="true"></e-data-manager>
        </ejs-autocomplete>
    </div>
</div>

Offline.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using WebApplication1.Models;

namespace WebApplication1.Controllers
{
    public class AutoCompleteController : Controller
    {
        public ActionResult offline()
        {
            return View();
        }
    }
}

See Also

• How to load data using template
• How to group the data using header
• How to filter the bound data