ASP.NET MVC Controls | ComponentOne
Working with Controls / FlexGrid / Work with FlexGrid / Custom Editors
In This Topic
    Custom Editors
    In This Topic

    FlexGrid provides in-built support for Excel like fast editing, however, in certain cases you may need advance editing experience. To enable such editing, you can customize your editing experience by using custom editors and specify custom editor controls using the Editor property on the Column. The Editor property simply sets a reference to an MVC input control to be used as a custom cell editor. For this, you can use any input control that you want, including Date Picker, Numeric Textbox, AutoComplete, Color Picker, and more.

    The following example demonstrates how you can use MVC InputDate, InputTime, ComboBox, InputNumber, and InputColor controls as custom editors. To use an input control as a custom editor, all you have to do is associate an instance of the control with a grid column or a style using its Editor property. This example also showcases how CellTemplate can be used for customizing the editors further in some of the columns.

    To accomplish this, follow these steps:

    Create an MVC Application

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

    Back to Top

    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 
      using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;

namespace FlexGrid_MVC.Models
{
    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; }

        private static List<string> COUNTRIES = new List<string> { "US", "UK", "Canada", "Japan", "China", "France", "German", "Italy", "Korea", "Australia" };
        private static List<string> PRODUCTS = new List<string> { "Widget", "Gadget", "Doohickey" };
        private static List<string> COLORS = new List<string> { "Black", "White", "Red", "Green", "Blue" };
        /// <summary>
        /// Get the data.
        /// </summary>
        /// <param name="total"></param>
        /// <returns></returns>
        public static IEnumerable<Sale> GetData(int total)
        {
            var rand = new Random(0);
            var dt = DateTime.Now;
            var list = Enumerable.Range(0, total).Select(i =>
            {
                var country = COUNTRIES[rand.Next(0, COUNTRIES.Count - 1)];
                var product = PRODUCTS[rand.Next(0, PRODUCTS.Count - 1)];
                var color = COLORS[rand.Next(0, COLORS.Count - 1)];
                var startDate = new DateTime(dt.Year, i % 12 + 1, 25);
                var endDate = new DateTime(dt.Year, i % 12 + 1, 25, i % 24, (i % 2) * 30, 0);

                return new Sale
                {
                    ID = i + 1,
                    Start = startDate,
                    End = endDate,
                    Country = country,
                    Product = product,
                    Color = color,
                    Amount = Math.Round(rand.NextDouble() * 10000 - 5000, 2),
                    Amount2 = Math.Round(rand.NextDouble() * 5000, 2),
                    Discount = Math.Round(rand.NextDouble() / 4, 2),
                    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 static List<string> GetCountries()
        {
            var countries = new List<string>();
            countries.AddRange(COUNTRIES);
            return countries;
        }

        public static List<string> GetProducts()
        {
            List<string> products = new List<string>();
            products.AddRange(PRODUCTS);
            return products;
        }
    }


    public class MonthData
    {
        public int Month { get; set; }
        public double Data { get; set; }
    }
}

    Back to Top

    Add Custom Editors to the 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 MVC 5 Controller - Empty template.
      2. Set name of the controller (for example: CustomEditorController).
      3. Click Add.
    4. Replace the method Index() with the following method.

      IndexController.cs

      C#
      Copy Code 
      using FlexGrid_MVC.Models;

namespace FlexGrid_MVC.Controllers
{
    public class CustomEditorController : Controller
    {
        // GET: CustomEditor
        public ActionResult Index()
        {
            return View(Sale.GetData(15));
        }
    }
}
      Note: Replace FlexGrid_MVC.Models; with <YourMVCApplicationName>.Models; in the references.

    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.
      Razor
      Copy Code 
      @using FlexGrid_MVC.Models
@model IEnumerable<Sale>

@{
    List<string> countries = Sale.GetCountries();
    List<string> products = Sale.GetProducts();
}

<style type="text/css">
    .grid {
        height: 500px;
        border: 2px solid #e0e0e0;
        font-family: Cambria;
        font-weight: bold;
    }
</style>

<script id="edtDate" type="text/template">
    @(Html.C1().InputDate()
        .Id("dateEditor")
        .Format("d")
        .IsRequired(false) // add this for new row
        .CssStyle("width", "100%") // full with the cell
        .TemplateBind("Value", "Start")
        .ToTemplate()
    )
</script>
<script id="edtTime" type="text/template">
    @(Html.C1().InputTime()
        .Id("timeEditor")
        .Step(30)
        .Format("t")
        .IsRequired(false) // add this for new row
        .CssStyle("width", "100%") // full with the cell
        .TemplateBind("Value", "End").ToTemplate()
    )
</script>
<script id="edtAmount" type="text/template">
    @(Html.C1().InputNumber()
        .Id("amountEditor")
        .Format("c2")
        .IsRequired(false) // add this for new row
        .CssStyle("width", "100%") // full with the cell
        .Step(10)
        .TemplateBind("Value", "Amount").ToTemplate()
    )
</script>
<script id="edtCountry" type="text/template">
    @(Html.C1().ComboBox()
        .Id("countryEditor")
        .IsEditable(false)
        .Bind(countries)
        .CssStyle("width", "100%") // full with the cell
        .TemplateBind("Text", "Country").ToTemplate()
    )
</script>
<script id="edtProduct" type="text/template">
    <input type="text" id="{{uid}}" onfocus="productEditorFocus(event)" onblur="productEditorBlur(event)" style="width:100%;height:100%" value="{{Product}}" />
</script>
<script id="edtColor" type="text/template">
    @(Html.C1().InputColor()
        .Id("colorEditor")
        .CssStyle("width", "100%") // full with the cell
        .TemplateBind("Text", "Color").ToTemplate()
    )
</script>

@(Html.C1().InputDate()
        .Id("dateEditor1")
        .Format("d")
        .IsRequired(false) // add this for new row
        .CssStyle("width", "100%") // full with the cell
)
@(Html.C1().ComboBox()
        .Id("countryEditor1")
        .IsEditable(false)
        .Bind(countries)
        .CssStyle("width", "100%") // full with the cell
)
@(Html.C1().InputColor()
        .Id("colorEditor1")
        .CssStyle("width", "100%") // full with the cell
)

@*Instantiate FlexGrid and set its properties*@
@(Html.C1().FlexGrid<Sale>()
           .AutoGenerateColumns(false)
           .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").Width("0.4*"));
                 bl.Add(cb => cb.Binding("Start").Header("Date").Format("d").Editor("dateEditor1"));
                 bl.Add(cb => cb.Binding("End").Header("Time").Format("t").CellTemplate(ctb => ctb.EditTemplateId("edtTime")));
                 bl.Add(cb => cb.Binding("Country").Editor("countryEditor1"));
                 bl.Add(cb => cb.Binding("Product").CellTemplate(ctb => ctb.EditTemplateId("edtProduct")));
                 bl.Add(cb => cb.Binding("Amount").Format("c").Format("n2").Width("1.0*").CellTemplate(ctb => ctb.EditTemplateId("edtAmount")));
                 bl.Add(cb => cb.Binding("Color").Editor("colorEditor1"));
                 bl.Add(cb => cb.Binding("Active"));
           }))

    Back to Top

    Build and Run the Project

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

    Back to Top