ASP.NET MVC Controls
Quick Start: Add data to FlexGrid

This section describes how to add a FlexGrid control to your MVC application and populate data in it. The below example demonstrates local model binding in FlexGrid control. For detailed explanation on how to do remote binding in FlexGrid, see Remote Data Binding topic.

This topic comprises of three steps:

The following image shows how the FlexGrid appears after completing the steps:

Back to Top

Step 1: Create an MVC Application

Create a new MVC application using the ComponentOne templates. For more information about creating an MVC application, see Configuring your MVC Application topic.

Step 2: Create a Datasource for FlexGrid

  1. Add a new class to the folder Models (for example: Sale.cs). See Adding controls to know how to add a new model.
  2. Replace the following code in the new model to define the classes that serve as a datasource for the FlexGrid control.
    Sale.cs
    Copy Code
        public class Sale
        {        
            public int ID { get; set; }
            public DateTime Start { get; set; }
            public DateTime End { get; set; }
            public string Country { get; set; }
            public string Product { get; set; }
            public string Color { get; set; }
            public double Amount { get; set; }
            public double Amount2 { get; set; }
            public double Discount { get; set; }
            public bool Active { get; set; }
    
            public MonthData[] Trends { get; set; }
            public int Rank { get; set; }
    
            /// <summary>
            /// Get the data.
            /// </summary>
            /// <param name="total"></param>
            /// <returns></returns>
            public static IEnumerable<Sale> GetData(int total)
            {
                var countries = new[] { "US", "UK", "Canada", "Japan", "China", "France", "German", "Italy", "Korea", "Australia" };
                var products = new[] { "Widget", "Gadget", "Doohickey" };
                var colors = new[] { "Black", "White", "Red", "Green", "Blue" };
                var rand = new Random(0);
                var dt = DateTime.Now;
                var list = Enumerable.Range(0, total).Select(i =>
                {
                    var country = countries[rand.Next(0, countries.Length - 1)];
                    var product = products[rand.Next(0, products.Length - 1)];
                    var color = colors[rand.Next(0, colors.Length - 1)];
                    var date = new DateTime(dt.Year, i % 12 + 1, 25, i % 24, i % 60, i % 60);
    
                    return new Sale
                    {
                        ID = i + 1,
                        Start = date,
                        End = date,
                        Country = country,
                        Product = product,
                        Color = color,
                        Amount = rand.NextDouble() * 10000 - 5000,
                        Amount2 = rand.NextDouble() * 10000 - 5000,
                        Discount = rand.NextDouble() / 4,
                        Active = (i % 4 == 0),
                        Trends = Enumerable.Range(0, 12).Select(x => new MonthData { Month = x + 1, Data = rand.Next(0, 100) }).ToArray(),
                        Rank = rand.Next(1, 6)
                    };
                });
                return list;
            }
        }
    
        public class MonthData
        {
            public int Month { get; set; }
            public double Data { get; set; }
        }
    }
    
Back to Top

Step 3: Add a FlexGrid control

Complete the following steps to initialize a FlexGrid control.

Add a new Controller

  1. In the Solution Explorer, right click the folder Controllers.
  2. From the context menu, select Add | Controller. The Add Scaffold dialog appears.
  3. Complete the following steps in the Add Scaffold dialog:
    1. Select Empty MVC Controller template.
    2. Set name of the controller (for example: Default1Controller).
    3. Click Add.
  4. Include the MVC references as shown below.
    C#
    Copy Code
    using System.Collections;
    using System.Globalization;
    using System.Linq;
    using System.Web.Mvc;
    using C1.Web.Mvc;
    using MVCFlexGrid.Models;
    using System.Collections.Generic;
    using System;
    

    Note: Replace MVCFlexGrid.Models; with <YourMVCApplicationName>.Models; in the references.
  5. Replace the method Index() with the following method.

    IndexController.cs

    C#
    Copy Code
    public ActionResult Index()
    {
        return View(Sale.GetData(15));
    }
    
    VB
    Copy Code
    Public Function Index() As ActionResult
            Return View(Sale.GetData(15))
    End Function
    

Add a View for the controller:

  1. From the Solution Explorer, expand the folder Controllers and double click the controller (for example: Default1Controller) to open it.
  2. Place the cursor inside the method Index().
  3. Right click and select Add View. The Add View dialog appears.
  4. In the Add View dialog, verify that the View name is Index and View engine is Razor (CSHTML).
  5. Click Add. A view has been added for the controller.
  6. In the Solution Explorer, double click Index.cshtml to open it.
  7. Replace the default code of the Views\Index.cshtml file with the one given below to initialize a FlexGrid control.
    Index.cshtml
    Copy Code
    @using MVCFlexGrid.Models
    @using C1.Web.Mvc.Grid
    
    @model IEnumerable<Sale>
    
     // Instantiate FlexGrid and set its properties
    
    @(Html.C1().FlexGrid<Sale>()
        .AutoGenerateColumns(false)
        .Height(450)
        .Width(700)
        .AllowAddNew(true)
        .SelectionMode(C1.Web.Mvc.Grid.SelectionMode.Cell)
        .CssClass("grid")
        .Bind(Model)
        
     // Binding columns data to FlexGrid
     
         .Columns(bl =>  
           {
                bl.Add(cb => cb.Binding("ID"));
                bl.Add(cb => cb.Binding("Start"));
                bl.Add(cb => cb.Binding("Product"));
                bl.Add(cb => cb.Binding("Amount").Format("c"));
                bl.Add(cb => cb.Binding("Discount").Format("p0"));
                bl.Add(cb => cb.Binding("Active"));
            })
    )
    

    Index.vbhtml
    Copy Code
    @Imports C1.Web.Mvc
    @Imports C1.Web.Mvc.Fluent
    @Imports C1.Web.Mvc.Grid
    @ModelType IEnumerable(Of Sale)
    
    @(Html.C1().FlexGrid(Of Sale)() _
    .CssClass("grid") _
    .Bind(Model) _
    .AutoGenerateColumns(False) _
    .Width(700) _
    .Height("800px") _
    .SelectionMode(C1.Web.Mvc.Grid.SelectionMode.Cell) _
    .Columns(Sub(bl)
                    bl.Add(Sub(cb) cb.Binding("ProductName"))
                    bl.Add(Sub(cb) cb.Binding("SupplierID"))
                    bl.Add(Sub(cb) cb.Binding("QuantityPerUnit"))
                    bl.Add(Sub(cb) cb.Binding("UnitPrice"))
                    bl.Add(Sub(cb) cb.Binding("UnitsInStock"))
                    bl.Add(Sub(cb) cb.Binding("UnitsOnOrder"))
                    bl.Add(Sub(cb) cb.Binding("Discontinued"))
                    End Sub) _)
    
    HTML
    Copy Code
    @using TagFlexGrid.Models
    @using C1.Web.Mvc.Grid
    @model IEnumerable<Sale>
    
    <c1-flex-grid auto-generate-columns="false" height="500px" width="800px" class="grid"
                   is-read-only="true" allow-add-new="true"
                  allow-sorting="true"              
                  selection-mode="@((SelectionMode.Cell))" >
        <c1-items-source read-action-url="@Url.Action("Index_Bind")"></c1-items-source>
        <c1-flex-grid-column binding="ID"></c1-flex-grid-column>
        <c1-flex-grid-column binding="Start"></c1-flex-grid-column>
        <c1-flex-grid-column binding="Product"></c1-flex-grid-column>
        <c1-flex-grid-column binding="Amount" format="c"></c1-flex-grid-column>
        <c1-flex-grid-column binding="Discount" format="p0"></c1-flex-grid-column>
        <c1-flex-grid-column binding="Active"></c1-flex-grid-column>
    
    </c1-flex-grid>
    

Step 4: Build and Run the Project

  1. Click Build | Build Solution to build the project.
  2. Press F5 to run the project.

Back to Top

See Also

Reference

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback