Alphabetic Paging In ASP.NET MVC

Introduction

 

This article will explain to you alphabetic pagination in ASP.Net MVC. The idea here is to create pagination alphabetically where user can see the pagination of A to Z. When user clicks on A the customer name with "A" alphabet display similarly user can perform pagination from A to Z and the user can also see All the customer by clicking on "All".

 

This example requires the following basic understanding

• Bootstrap
• Entity framework
• LINQ
• ViewModel
• MVC

Step 1

 

Open your favourite SQL server database any version. It doesn’t really matter. Create tables’ customer.

CREATE TABLE [dbo].[Customer](
    [Id] [int] IDENTITY(1,1) NOT NULL,
    [FirstName] [nvarchar](40) NOT NULL,
    [LastName] [nvarchar](40) NOT NULL,
    [City] [nvarchar](40) NULL,
    [Country] [nvarchar](40) NULL,
    [Phone] [nvarchar](20) NULL,
 CONSTRAINT [PK_CUSTOMER] PRIMARY KEY CLUSTERED
(
    [Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]

GO

Step 2

 

Now open your favourite visual studio 2017 or any version you wish to.

 

 

Step 3

 

Create an empty project in visual studio and give an appropriate name. Checked MVC checkbox and click on OK.

 

 

Step 4

 

Right-click on the Models folder and add a database model. Add Entity Framework now. For that, right-click on Models folder, select Add, then select New Item.

 

 

You will get a window; from there, select Data from the left panel and choose ADO.NET Entity Data Model, give it the name MyModel (this name is not mandatory, you can give any name) and click "Add"

 

 

After you click on "Add a window", the wizard will open. Choose EF Designer from the database and click "Next".

 

 

After clicking on "Next", a window will appear. Choose New Connection. Another window will appear. Add your server name - if it is local, then enter a dot (.). Choose your database and click "OK".

 

 

The connection will be added. If you wish, save the connection name as you want. You can change the name of your connection below. It will save the connection in the web config. Now, click "Next".

 

 

After clicking on NEXT, another window will appear. Choose the database table name as shown in the below screenshot and click "Finish".

 

 

Entity Framework gets added and the respective class gets generated under the Models folder.

 

 

Step 5

 

Right-click on Controllers folder add a controller.

 

 

A window will appear. Choose MVC5 Controller-Empty and click "Add".

 

 

After clicking on "Add", another window will appear with DefaultController. Change the name to HomeController and click "Add". The HomeController will be added under the Controllers folder. Don’t change the Controller suffix for all controllers, change only the highlight, and instead of Default, just change Home.

 

 

Step 6

 

Right click on project “Add Folder” name it ViewModels. Now right click on this folder and “Add Class” with name AlphabeticCustomerPagingViewModel. 

using MvcAlphabaticPagination_Demo.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;

namespace MvcAlphabaticPagination_Demo.ViewModels
{
    public class AlphabeticCustomerPagingViewModel
    {
        public List<string> CustomerName { get; set; }
        public IList<string> Alphabet
        {
            get
            {
                var alphabet = Enumerable.Range(65, 26).Select(i => ((char)i).ToString()).ToList();
                alphabet.Insert(0, "All");
                return alphabet;
            }
        }
        public List<string> FirstLetters { get; set; }
        public string SelectedLetter { get; set; }
        public bool NamesStartWithNumbers
        {
            get
            {
                var numbers = Enumerable.Range(0, 10).Select(i => i.ToString());
                return FirstLetters.Intersect(numbers).Any();
            }
        }
    }
}

Controller Class Code

using MvcAlphabaticPagination_Demo.Models;
using MvcAlphabaticPagination_Demo.ViewModels;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;

namespace MvcAlphabaticPagination_Demo.Controllers
{
    public class HomeController : Controller
    {
        private readonly CustomerContext db = new CustomerContext();

        public ActionResult Index(string selectedLetter)
        {
            var viewModel = new AlphabeticCustomerPagingViewModel { SelectedLetter = selectedLetter };

            viewModel.FirstLetters =db.Customers
            .GroupBy(c => c.FirstName.Substring(0, 1))
            .Select(x => x.Key.ToUpper())
            .ToList();

            if (string.IsNullOrEmpty(selectedLetter) || selectedLetter == "All")
            {
                viewModel.CustomerName = db.Customers
                    .Select(c => c.FirstName)
                    .ToList();
            }
            else
            {
                if (selectedLetter == "0-9")
                {
                    var numbers = Enumerable.Range(0, 10).Select(i => i.ToString());
                    viewModel.CustomerName = db.Customers
                        .Where(p => numbers.Contains(p.FirstName.Substring(0, 1)))
                        .Select(p => p.FirstName)
                        .ToList();
                }
                else
                {
                    viewModel.CustomerName = db.Customers
                        .Where(p => p.FirstName.StartsWith(selectedLetter))
                        .Select(p => p.FirstName)
                        .ToList();
                }
            }

                return View(viewModel);
        }
    }
}

Step 7

 

Right click on Index action method in controller class to “Add View”

 

 

 

Index View Code

@model MvcAlphabaticPagination_Demo.ViewModels.AlphabeticCustomerPagingViewModel

@{
    ViewBag.Title = "Index";
}

<h4 class="text-center text-uppercase">Alphabetic Search in ASP.Net MVC</h4>

<ul class="pagination alpha">
    @foreach (var link in Model.Alphabet)
    {
        if (Model.FirstLetters.Contains(link) || (Model.NamesStartWithNumbers && link == "0-9") || link == "All")
        {
            if (Model.SelectedLetter == link || Model.SelectedLetter.IsEmpty() && link == "All")
            {
                <li class="page-item active"><a class="page-link" href="#">@link</a></li>
            }
            else
            {
                <li class="page-item">@Html.ActionLink(link, "Index", new { selectedLetter = link },new { @class= "page-link" })</li>
            }
        }
        else
        {
            <li class="page-item inactive"><a class="page-link" href="#">@link</a></li>
        }
    }
</ul>

<ul class="list-group">
    @foreach (var item in Model.CustomerName)
    {
        <li class="list-group-item list-group-item-primary">@item</li>
    }
</ul>

Step 8

 

Install the latest version of bootstrap from NuGet package manager under tools in visual studio.

 

Step 9

 

Build your project and Run by pressing Ctrl+F5