ASP.NET Core
EditEdit This DocumentInstall NuGet
Demos
Support
Forum
Upgrade Guide
FREE TRIAL
Search results

Templates in ASP.NET Core AutoComplete control

The AutoComplete has been provided with several options to customize each list items, group title, header and footer elements. It uses the Essential JS 2 Template engine to compile and render the elements properly.

Item template

The content of each list item within the AutoComplete can be customized with the help of itemTemplate property.

In the following sample, each list item is split into two columns to display relevant data’s.

tagHelper
itemtemplate.cs
<div class='control-wrapper'>
    <div style='padding-top:75px;'>
        <ejs-autocomplete id="customers" query="new ej.data.Query().from('Employees').select(['FirstName', 'City', 'EmployeeID']).take(6)" placeholder="Select a customer" popupHeight="200px"
                          itemTemplate="@Html.Raw("<span><span class='name'>${FirstName}</span><span class ='city'>${City}</span></span>")">
            <e-autocomplete-fields value="FirstName"></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>

<style>
    .city {
        right: 15px;
        position: absolute;
    }
</style>
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 IActionResult Itemtemplate()
        {
            return View();
        }       
    }
}

Group template

The group header title under which appropriate sub-items are categorized can also be customize with the help of groupTemplate property. This template is common for both inline and floating group header template.

In the following sample, employees are grouped according to their city.

tagHelper
grouptemplate.cs
<div class='control-wrapper'>
    <div style='padding-top:75px;'>
        <ejs-autocomplete id="customers" query="new ej.data.Query().from('Employees').select(['FirstName', 'City', 'EmployeeID']).take(6).where(new ej.data.Predicate('City', 'equal','london').or('City','equal','seattle'))" placeholder="Select a customer" popupHeight="200px"
                          groupTemplate="@Html.Raw("<strong>${City}</strong>")">
            <e-autocomplete-fields groupBy="City" value="FirstName"></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>
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 IActionResult grouptemplate()
        {
            return View();
        }       
    }
}

Header template

The header element is shown statically at the top of the suggestion list items within the AutoComplete, and any custom element can be placed as a header element using headerTemplate property.

In the following sample, the list items and its headers are designed and displayed as two columns similar to multiple columns of the grid.

tagHelper
headertemplate.cs
<div class='control-wrapper'>
    <div style='padding-top:75px;'>
        <ejs-autocomplete id="customers" query="new ej.data.Query().from('Employees').select(['FirstName', 'City', 'EmployeeID']).take(6)" placeholder="Find an Employee" popupHeight="200px"
                          headerTemplate="@Html.Raw("<span class='head'><span class='name'>Name</span><span class='city'>City</span></span>")"
                          itemTemplate="@Html.Raw("<span class='item' ><span class='name'>${FirstName}</span><span class='city'>${City}</span></span>")">
            <e-autocomplete-fields value="FirstName"></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>

<style>
    .head, .item {
        display: table;
        width: 100%;
        margin: auto;
    }

    .head {
        height: 40px;
        font-size: 15px;
        font-weight: 600;
    }

    .name, .city {
        display: table-cell;
        vertical-align: middle;
        width: 50%;
    }

    .head .name {
        text-indent: 16px;
    }

    .head .city {
        text-indent: 10px;
    }
</style>
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 headertemplate()
        {
            return View();
        }       
    }
}

The AutoComplete has options to show a footer element at the bottom of the list items in the suggestion list. Here, you can place any custom element as a footer element using footerTemplate property.

In the following sample, footer element displays the total number of list items present in the AutoComplete.

tagHelper
footertemplate.cs
<div class='control-wrapper'>
    <div style='padding-top:75px;'>
        <ejs-autocomplete id="employees" dataSource="@ViewBag.data" placeholder="Select an game" popupHeight="270px"
                          footerTemplate="@Html.Raw( "<span class='foot'> Total list items: " + 8 + "</span>")">
            <e-autocomplete-fields value="Name"></e-autocomplete-fields>
        </ejs-autocomplete>
    </div>
</div>
<style>
    .foot {
        text-indent: 1.2em;
        display: block;
        font-size: 15px;
        line-height: 40px;
        border-top: 1px solid #e0e0e0;
    }
</style>
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 footertemplate()
        {
            ViewBag.data = new string[] { "Badminton", "Basketball", "Cricket", "Football", "Golf", "Gymnastics", "Hockey", "Tennis" };
            return View();
        }
    }
}

No records template

The AutoComplete is provided with support to custom design the suggestion list content when no data is found and no matches found on search with the help of noRecordsTemplate property.

In the following sample, suggestion list content displays the notification of no data available.

tagHelper
norecordstemplate.cs
<div class='control-wrapper'>
    <div style='padding-top:75px;'>
        <ejs-autocomplete id="employees" dataSource="@ViewBag.data" placeholder="Select an employee" popupHeight="270px"
                          noRecordsTemplate="@Html.Raw("<span class='norecord'> NO DATA AVAILABLE</span>")">
            <e-autocomplete-fields value="Name"></e-autocomplete-fields>
        </ejs-autocomplete>
    </div>
</div>
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 IActionResult norecords()
        {
            ViewBag.data = new string[] { };
            return View();
        }
    }
}

Action failure template

There is also an option to custom design the suggestion list content when the data fetch request fails at the remote server. This can be achieved using the actionFailureTemplate property.

In the following sample, when the data fetch request fails, the AutoComplete displays the notification.

tagHelper
actionfailuretemplate.cs
<div class='control-wrapper'>
    <div style='padding-top:75px;'>
        <ejs-autocomplete id="customers" query="new ej.data.Query().from('Employees').select(['FirstName']).take(6)" placeholder="Select a customer" popupHeight="200px"
                          actionFailureTemplate="@Html.Raw("<span class='action-failure'> Data fetch get fails</span>")">
            <e-autocomplete-fields value="FirstName"></e-autocomplete-fields>
            <e-data-manager url="https://services.odata.org/V4/Northwind/Northwind.svcs/" adaptor="ODataV4Adaptor" crossDomain="true"></e-data-manager>
        </ejs-autocomplete>
    </div>
</div>
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 actionfailure()
        {
            return View();
        }
    }
}

See Also

Previous
Next