Documentation

Bind jqxGrid to SQL Database using ASP.NET MVC3

In this tutorial we are going to introduce you how to use jqxGrid in ASP.NET MVC 3.

If you haven't already installed ASP.NET MVC 3 use this resource: http://www.asp.net/mvc/mvc3
For this tutorial you're also going to need the Entity Framework: http://www.microsoft.com/download/en/details.aspx?id=18504
For our purpose we will use the Northwind database which you can download from here. So let's begin!

Create new ASP.NET MVC 3 project and choose the "Empty project" option for template. For "View engine" select "Razor".

1. You have to load the database. Drag the files: "NORTHWND.LDF" and "NORTHWND.MDF" and drop them over the "App_Data" directory in your project. If there's no "App_Data" folder then right click on the white space in the "Solution Explorer" choose "Add -> Add ASP.NET Folder -> App_Data".>
2. Add all required JavaScript and CSS files. In the sample we added references to jqx-all.js, jqx.base.css and jqx.classic.css.
3. Expand the "View" directory after that the "Shared" and double click on "_Layout.cshtml". Include all the files you've added into the previous steps. If there are older versions of jQuery included, in the "_Layout.cshtml" file, just delete them. After finishing the last step your "_Layout.cshtml" should look like this:
4. In the next step we're going to create our Models. Now right click on the "Models" folder. Select "Add -> New Item". Choose "Data" from the tree view in left. Select "ADO.NET Entity Data Model" and click "Add".
   
   
   
   In the "Choose Model Contents" section select "Generate from database" and click Next.
   
   
   
   In the "Choose Your Data Connection" section click next. The the next section ("Choose Your Database Objects") check the "Tables" and "Stored Procedures" checkboxes and click "Finish".
   
   
   
   
5. For our purpose we are going to use the "Customers" table. To add entity objects and DbContext you have to expand the Models directory. Double click on "Model1.edmx". In the diagram appeared, right click on the white space and choose "Add Code Generation Item". In the tree view in left, select "Code", choose "ADO.NET DbContext Generator" and click "Add".
   
   
   
   
6. After that press F6 to Build your project.
7. Now we are ready to add our Controller. Right click on the "Controller" folder and after that choose "Add -> Controller". Rename it "CustomersController". The choosen template should be "Controller with read/write actions and views, using Entity Framework". For Model class select "Customer (Project.Models)" and for Data context class "NORTHWNDEntities2 (Project.Models)" after that choose "Add".
   
   
   
   
8. After the generation of the controller have been completed go to the "Controllers" folder and double click on "CustomersController.cs". Add the following method after the "Index" method:

   public JsonResult GetCustomers()
   {
       var dbResult = db.Customers.ToList();
       var customers = from customer in dbResult
                       select new { customer.CompanyName, customer.ContactName, customer.ContactTitle, customer.Address, customer.City };
       return Json(customers, JsonRequestBehavior.AllowGet);
   }
   

9. After that go to the "Views/Customers" folder in your project. Double click on "Index.cshtml". Put there the following content:

   <script type="text/javascript">
       $(document).ready(function () {
           // prepare the data
           var source = {
               datatype: "json",
               datafields: [{ name: 'CompanyName' }, { name: 'ContactName' }, { name: 'ContactTitle' }, { name: 'Address' }, { name: 'City' } ],
               url: 'Customers/GetCustomers'
           };
           var dataAdapter = new $.jqx.dataAdapter(source);
          
           $("#jqxgrid").jqxGrid({
               source: dataAdapter,
               theme: 'classic',
               columns: [{ text: 'Company Name', datafield: 'CompanyName', width: 250 }, { text: 'ContactName', datafield: 'ContactName', width: 150 }, { text: 'Contact Title', datafield: 'ContactTitle', width: 180 }, { text: 'Address', datafield: 'Address', width: 200 }, { text: 'City', datafield: 'City', width: 120}]
           });
       });
   </script>
   

10. In the last step expand "Global.asax" and double click on "Global.asax.cs". Change the "RegisterRoutes" method to look like this:

    public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
        routes.MapRoute(
            "Customers", // Route name
            "{controller}/{action}/{id}", // URL with parameters
            new { controller = "Customers", action = "Index", id = UrlParameter.Optional } // Parameter defaults
        );
    }