3 super easy steps to create a Kendo UI grid and integrate a drop down list in inline edit mode
This post will guide you through the following:
- Build a Kendo grid using the MVC razor wrappers
- Integrate an inline drow down list in an editable column
- Solve saving nullable model properties bound to drop down menus inside the Kendo grid on both create and edit events
Telerik Kendo Controls makes things pretty easy for both UX and UI developers as well as those who are using technologies such as ASP.NET MVC or other similar ones. This article illlustrates how the Kendo drop-down lists can be integrated into Kendo grids and used to advantage by programmers. Having a Kendo grid drop-down column in MVC is frequently used by web developers in the inline-editing mode of the grid.
You might also be interested in ASP.NET MVC DropdownLists where I explained in 3 steps how to create MVC DropDownLists with the least efforts using a straightforward data source, Razor helper, and a single Bootstrap CSS class.
Note: This assumes that the person reading this post has a reasonable knowledge of ASP.NET MVC, Kendo UI (razor wrappers), as well as the related terminologies.
This article details in a step-by-step manner as to how to integrate the two options in a smooth way using Kendo wrappers.
(Figure 1: Kendo dropdown list included in the Kendo grid)
Before we start: A quick video using Kendo grids in MVC
It might be useful to have a quick overview of how to build Kendo grids in MVC and compare them with traditional grids in ASP.NET to outline the differences and the out-of-the-box features granted when dealing with Kendo
Now let's move on to creating the Kendo grid with MVC code and how to add a dropdown list in inline editing mode in just three steps.
Step 1 – Creating a Kendo UI Project (Optional)
Firstly, install Kendo UI on your development server in case you have not already done so. If you have not yet done so, go to Kendo Downloads and install the version of your choice. Soon after, Kendo UI will introduce a few project templates by default in your Visual Studio. Those project templates can help you to create any project with the ease that has Kendo UI integrated into it by default. Figure 2 displays some of those project templates that are automatically installed by Kendo UI.
(Figure 2: Kendo UI – Project Templates Installed)
Step 2 – Creating A Kendo Grid
After creating a Kendo project (using the default templates of your choice) the next job is to use the Kendo grid MVC razor wrappers to create the views that your project requires. The Kendo grid can be used thus using the following razor wrapper (relevant code is below).
Snippet 1: consists of a grid that contains the employee details such as the employee first name, employee last name, and the name of the company. The definition of the Employee class follows:
Snippet 2: Employee class
This class of the following fields: employee id, employee first name, employee last name, company id, and company name. These class properties have columns in the Kendo grid with the same names as in the code. The data corresponding to this code is gathered using any framework from a data repository (It is outside the premise of this article to elaborate more on this). The code that follows this section presents the data to the data source. However, you should bear in mind that the code must retrieve the field
"CompanyName" for every employee. (The code listed below only serves as an example. You should replace this with your code to get the job done.)
Snippet 3: Employee data
Step 3 – Embedding the Kendo Drop-down List
The next step involves populating the Kendo drop-down list with the company names. This stage will help the user to select a company name from those that appear in a drop-down menu when he chooses either the create mode or the edit mode of the grid. The user then selects the company that corresponds to that the specific employee. The code that binds the column to
CompanyId is shown below as point (1.). It can be seen in the Kendo MVC Grid creation step as well. Point (2.) explains how the code executes.
1. Ajax action that returns JsonResult and the drop-down binding in the grid
Snippet 4: The above piece of code should be inside the controller
Snippet 5: The above piece of code should be in Kendo grid in the view
2. The explanation for the above code is as follows:The
EditorTemplateNamespecifies to the grid that when either in
Editmodes, the template should be placed in the data file named
"CompaniesList"that you can find in the directory by the name of
EditorTemplates. The subsequent step therefore involves the creation of a folder by the name of
"EditorTemplates"and place an empty view in it by name of
"CompaniesList". The code bit
"ClientTemplate(“#:CompanyName#”)"means that when the display is in the view mode, (that is, not creating or editing)
CompanyNamehas to be displayed (in this case, it is "Microsoft"). Once this is complete, all that remains that you can do is the creation of drop-down list which will be used in the view. The
ViewBag.Companiesdynamic property provides the data to the drop-down list. However, this has to be added to the code as shown below:
Snippet 6: The drop-down editor template
The above snippet should be in a separate view in
"EditorTemplates" folder with the same name given to the
EditorTemplateName in snippet 5 which is
You should take care while writing the code for creating the Kendo grid, the most critical point being the statement
Name(“CompanyId”). This name helper
CompanyId should be the same as the column name that the drop-down is bound to in the grid. In this specific example, the field to which column is bound to is shown as
"CompanyId", and this should be the name of the drop-down.
Snippet 7: drop-down list data as companies
GetAllCompanies() method will be something like this. (You should replace this method with your own)
Snippet 8: companies data
Nullable Model Properties – How to Take Care
If your model contains nullable properties of types integer, float or byte, it is not possible for the Kendo grid to update model properties to desired values during Create or Edit events. Nullable properties can create bugs in the drop-downs. Therefore, if the field
Nullable<int> instead of just
int, then you may have to add code to
save this event (to the grid) as follows:
Snippet 9: Kendo grid save event callback registration
Snippet 10: Kendo grid save event callback implementation
You are done with integrating a Kendo drop-down list inside a Kendo grid
Now you have done everything, just build your project and check the Kendo MVC grid in inline mode, while creating or editing, with the Kendo drop-down list integrated.