Search results

Filtering

The ComboBox has built-in support to filter data items when allowFiltering is enabled. The filter operation starts as soon as you start typing characters in the component.

To display filtered items in the popup, filter the required data and return it to the ComboBox via updateData method by using the filtering event.

The following sample illustrates how to query the data source and pass the data to the ComboBox through the updateData method in filtering event.

razor
filter.cs
Countries.cs
@Html.EJS().ComboBox("country").Placeholder("Select a COuntry").PopupHeight(
                   "230px").DataSource((IEnumerable<object>)ViewBag.localdata).Filtering("filtering").Fields(new ComboBoxFieldSettings { Text = "Name", Value = "Code" }).Render()


<script>
    function filtering() {
        var data = document.getElementById("country").ej2_instances[0];
        var query = new Query();
        //frame the query based on search string with filter type.
        query = (e.text != "") ? query.where("Name", "startswith", e.text, true) : query;
        //pass the filter data source, filter query to updateData method.
        e.updateData(data.dataSource, query);
    }
</script>
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 ComboBoxControlelr : Controller
    {
        public IActionResult filter()
        {
            ViewBag.data = new Countries().CountriesList();
            return View();
        }       
    }
}
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace WebApplication1.Models
{
    public class Countries
    {
        public string Name { get; set; }
        public string Code { get; set; }
        public List<Countries> CountriesList()
        {
            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" });
            return country;
        }
    }
}

Limit the minimum filter character

When filtering the list items, you can set the limit for character count to raise remote request and fetch filtered data on the ComboBox. This can be done by manual validation within the filter event handler.

In the following example, the remote request does not fetch the search data until the search key contains three characters.

razor
filterlimit.cs
@Html.EJS().ComboBox("customers").Placeholder("Select a customer").Filtering("onfiltering").PopupHeight("200px").DataSource(obj => obj.Url("http://services.odata.org/V4/Northwind/Northwind.svc/Customers").Adaptor(
        "ODataV4Adaptor").CrossDomain(true)).Fields(new ComboBoxFieldSettings { Text = "ContactName", Value = "CustomerID" }).Query((string)ViewBag.query).Render()

<script type="text/javascript">
    function onfiltering(e) {
        var data = document.getElementById('customers').ej2_instances[0];
         // load overall data when search key empty.
        if (e.text == '')
            e.updateData(data.dataSource);
        else {
            // restrict the remote request until search key contains 3 characters.
            if (e.text.length < 3) {
                return;
            }
            let query = new ej.data.Query().select(['ContactName', 'CustomerID']).take(7);
            query = (e.text !== '') ? query.where('ContactName', 'startswith', e.text, true) : query;
            e.updateData(data.dataSource, query);
        }
    }
</script>
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 ComboBoxController : Controller
    {
        public IActionResult filteringlimit()
        {
            return View();
        }
    }
}

Change the filter type

While filtering, you can change the filter type to contains, startsWith, or endsWith for string type within the filter event handler.

In the following examples, data filtering is done with endsWith type.

razor
filtertype.cs
@Html.EJS().ComboBox("customers").Placeholder("Select a customer").Filtering("onfiltering").PopupHeight("200px").DataSource(obj => obj.Url("http://services.odata.org/V4/Northwind/Northwind.svc/Customers").Adaptor(
        "ODataV4Adaptor").CrossDomain(true)).Fields(new ComboBoxFieldSettings { Text = "ContactName", Value = "CustomerID" }).Query((string)ViewBag.query).Render()

<script type="text/javascript">
    function onfiltering(e) {
        var data = document.getElementById('customers').ej2_instances[0];
         // load overall data when search key empty.
       var query = new ej.data.Query().select(['ContactName', 'CustomerID']).take(7);
       query = (e.text !== '') ? query.where('ContactName', 'endswith', e.text, true) : query;
        e.updateData(data.dataSource, query);       
    }
</script>
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 ComboBoxController : Controller
    {
        public IActionResult filtertype()
        {
            return View();
        }       
    }
}

Case sensitive filtering

Data items can be filtered either with or without case sensitivity using the DataManager. This can be done by passing the fourth optional parameter of the where clause.

The following example shows how to perform case-sensitive filter.

razor
casesensitive.cs
@Html.EJS().ComboBox("customers").Placeholder("Select a customer").Filtering("onfiltering").PopupHeight("200px").DataSource(obj => obj.Url("http://services.odata.org/V4/Northwind/Northwind.svc/Customers").Adaptor(
        "ODataV4Adaptor").CrossDomain(true)).Fields(new ComboBoxFieldSettings { Text = "ContactName", Value = "CustomerID" }).Query((string)ViewBag.query).Render()

<script type="text/javascript">
    function onfiltering(e) {
        var data = document.getElementById('customers').ej2_instances[0];
         // load overall data when search key empty.       
            var query = new ej.data.Query().select(['ContactName', 'CustomerID']).take(7);
            query = (e.text !== '') ? query.where('ContactName', 'startswith', e.text, false) : query;
            e.updateData(data.dataSource, query);       
    }
</script>
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 ComboBoxController : Controller
    {
        public IActionResult casesensitive()
        {
            return View();
        }       
    }
}

Diacritics filtering

ComboBox supports diacritics filtering which will ignore the diacritics and makes it easier to filter the results in international characters lists when the ignoreAccent is enabled.

In the following sample,data with diacritics are bound as dataSource for ComboBox.

The following example shows how to perform case-sensitive filter.

razor
diacritics.cs
@Html.EJS().ComboBox("list").DataSource((string[])ViewBag.data).Placeholder("e.g: aero").IgnoreAccent(true).AllowFiltering(true).Render()
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 ComboBoxController : Controller
    {
        public IActionResult diacritics()
        {
            ViewBag.data = new string[] { "Aeróbics", "Aeróbics en Agua", "Aerografía", "Aeromodelaje", "Águilas", "Ajedrez", "Ala Delta", "Álbumes de Música","Alusivos", "Análisis de Escritura a Mano"  };
            return View();
        }       
    }
}