Skip to main content

Storing and restoring Kendo Grid state from Database

There is no any built in way to store entire grid state into database and restore back again with all filters, groups, aggregates, page and page size.

At first, I was trying to restore only filters by looking through DataSourceRequest. DataSourceRequest is kind of communication medium between client and server for the operation we do on grid. All the request comes via DataSourceRequest. In previous approach, I was trying to store IFileDescriptor interface which come with class FileDescriptor by looping through filters and serializing into string for saving into database but this IFileDescriptor can also contain CompositeFilterDescriptor which can be nested in nested object which are very tricky to handle.

So, I had decompiled entire Kendo.MVC library and found out that all Kendo MVC controls are derived from “JsonObject”. It is there own implementation with ”Serialize” abstract function and “ToJson” function. In controls they are overriding “Serialize” method which depicts the object found on JavaScript for Kendo control. The “ToJson” function is returning “IDictionary<string,object>”. This is all we need. We can transform “IDictionary<string,object>” from “ToJson” and store into database and on initialization of grid on client side we can put these values directly on Kendo Grid.

Please note that serialization/direct storing could have been done directly on JavaScript level but there is no event associated to filters and might be same with other as well.

Let's start by defining Kendo MVC Grid control but we will not populate grid data right away while rendering. We got to initialize settings first (grid state from DB) and then populate data and restore grid state through “DataSource”. To stop grid data population Kendo MVC helper has “AutoBind()” function which can be set as “AutoBind(false)” .
Here is the entire grid sample:

 .Columns(columns =>  
      columns.Bound(vm => vm.LastName);  
      columns.Bound( vm => vm.FirstName);  
      columns.Bound( vm => vm.MiddleName);  
      columns.Bound( vm => vm.Id).Title("Id #");  
 .DataSource(datasource => datasource  
      .Read(read => read.Action("GetAllData", "SampleGrid", new { area = "" })  
 .Reorderable(reorder => reorder.Columns(true))  
 .Selectable(selectable => selectable.Mode(GridSelectionMode.Single)))  
 // JavaScript call  
 <script type=”text/javascript”>  

After setting up grid we need to initialize grid with data stored into DB through JavaScript.

 function RestoreGridSetting (gridId) {  
      if (gridId === undefined || gridId === null) {  
      // Select row  
      var grid = $('#' + gridId).data('kendoGrid');  
      if (grid === undefined) {  
      // Initialize columns  
      $.get('/api/userprofilegrid/' + gridId.toLowerCase(), function (data) {  
           if (data === undefined || data === null) {  
           // Set values from result of WebAPI call  

If the first request comes it will get information from WebApi and restore on grid via grid's datasource.
Now, let's look into action request which will be called from Grid control.

 .Read(read => read.Action("GetAllData", "SampleGrid", new { area = "" })  

Everything will remain as it is (DataSourceRequest) just that we need to save data into database which would be resulted by WebAPI call from JavaScript. So, here is server side code for GetAllData.

 var gridDetail = // TODO: Get object from DB;  
 if (gridDetail == null)  
 gridDetail.Aggregates = JsonConvert.SerializeObject(request.Aggregates.OfType<JsonObject>().ToJson());  
 gridDetail.Filters = JsonConvert.SerializeObject(request.Filters.OfType<JsonObject>().ToJson());  
 gridDetail.Groups = JsonConvert.SerializeObject(request.Groups.OfType<JsonObject>().ToJson());  
 gridDetail.PageSize = request.PageSize;  
 gridDetail.Sorts = JsonConvert.SerializeObject(request.Sorts.OfType<JsonObject>().ToJson());  
 //gridDetail.PageLocation = request.Page;  
 // TODO: Save object  

The above function is using Newtonsoft.JSON library to parse data from “IDictionary<string,object>” which is generated form “ToJson” call.

To summarize all of them as steps
1. Create grid control by setting “Autobind” as false.
2. Through AJAX call get grid state model and set the value into grid's datasource.
3. On server side grid's action to retrieve data, save DataSourceRequest properties with the help of “ToJson” and "JsonCovert".

NOTE: In this article, I have not covered restoring hidden columns and column grid position. There are plenty of resource that can be followed to achieve it.

Popular posts from this blog

Handling JSON DateTime format on Asp.Net Core

This is a very simple trick to handle JSON date format on AspNet Core by global settings. This can be applicable for the older version as well.

In a newer version by default, .Net depends upon Newtonsoft to process any JSON data. Newtonsoft depends upon Newtonsoft.Json.Converters.IsoDateTimeConverter class for processing date which in turns adds timezone for JSON data format.

There is a global setting available for same that can be adjusted according to requirement. So, for example, we want to set default formatting to US format, we just need this code.

services.AddMvc() .AddJsonOptions(options => { options.SerializerSettings.DateTimeZoneHandling = "MM/dd/yyyy HH:mm:ss"; });

LDAP with ASP.Net Identity Core in MVC with project.json

Lightweight Directory Access Protocol (LDAP), the name itself explain it. An application protocol used over an IP network to access the distributed directory information service.

The first and foremost thing is to add references for consuming LDAP. This has to be done by adding reference from Global Assembly Cache (GAC) into project.json

"frameworks": { "net461": { "frameworkAssemblies": { "System.DirectoryServices": "", "System.DirectoryServices.AccountManagement": "" } } },
These System.DirectoryServices and System.DirectoryServices.AccountManagement references are used to consume LDAP functionality.

It is always better to have an abstraction for irrelevant items in consuming part. For an example, the application does not need to know about PrincipalContext or any other dependent items from those two references to make it extensible. So, we can begin with some bas…

Architecture solution composting Repository Pattern, Unit Of Work, Dependency Injection, Factory Pattern and others

Project architecture is like garden, we plant the things in certain order and eventually they grow in similar manner. If things are planted well then they will all look(work) great and easier to manage. If they grow as cumbersome it would difficult to maintain and with time more problems would be happening in maintenance.

There is no any fixed or known approach to decide project architecture and specially with Agile Methodology. In Agile Methodology, we cannot predict how our end products will look like similarly we cannot say a certain architecture will fit well for entire development lifespan for project. So, the best thing is to modify the architecture as per our application growth. I understand that it sounds good but will be far more problematic with actual development. If it is left as it is then more problems will arise with time. Just think about moving plant vs a full grown tree.

Coming to technical side, In this article, I will be explaining about the various techniques tha…

Elegantly dealing with TimeZones in MVC Core / WebApi

In any new application handling TimeZone/DateTime is mostly least priority and generally, if someone is concerned then it would be handled by using DateTime.UtcNow on codes while creating current dates and converting incoming Date to UTC to save on servers.
Basically, the process is followed by saving DateTime to UTC format in a database and keep converting data to native format based on user region or single region in the application's presentation layer.
The above is tedious work and have to be followed religiously. If any developer misses out the manual conversion, then that area of code/view would not work.
With newer frameworks, there are flexible ways to deal/intercept incoming or outgoing calls to simplify conversion of TimeZones.
These are steps/process to achieve it. 1. Central code for storing user's state about TimeZone. Also, central code for conversion logic based on TimeZones. 2. Dependency injection for the above class to be able to use globally. 3. Creating Mo…

Unit Of Work injection through Asp.Net Core Dependency Injection

This article is not directly related to UnitOfWork but leveraging Asp.Net Core Dependency Injection to consume Unit Of Work.

In one of the previous article about project architecture, I was not very satisfied with the approach for Unit Of Work implementation for initialization of repository even if with some advantage.

Here is old code for UnitOfWork.

public sealed partial class MyProjectUnitOfWork : UnitOfWork<DbContext>, IMyProjectUnitOfWork { public MyProjectUnitOfWork(IContextFactory<DbContext> contextFactory) : base(contextFactory) { } /// <summary> /// BookRepository holder /// </summary> private MyProject.DB.Repository.BookRepository _bookRepository; /// <summary> /// Gets the BookRepository repository. /// </summary> /// <value> /// The BookRepository repository. /// </value> MyProject.Interface.Repository.IBoo…

Configuring Ninject, Asp.Net Identity UserManager, DataProtectorTokenProvider with Owin

It can be bit tricky to configure both Ninject and Asp.Net Identity UserManager if some value is expected from DI to configure UserManager. We will look into configuring both and also use OwinContext to get UserManager.

As usual, all configuration need to be done on Startup.cs. It is just a convention but can be used with different name, the important thing is to decorate class with following attribute to make it Owin start-up:

[assembly: OwinStartup(typeof(MyProject.Web.Startup))]
Ninject configuration

Configuring Ninject kernel through method which would be used to register under Owin.

public IKernel CreateKernel() { var kernel = new StandardKernel(); try { //kernel.Bind<IHttpModule>().To<HttpApplicationInitializationHttpModule>(); // TODO: Put any other injection which are required. return kernel; } catch { kernel.Dispose(); throw; }…

Global exception handling and custom logging in AspNet Core with MongoDB

In this, we would be looking into logging and global exception handling in the AspNet Core application with proper registration of logger and global exception handling.

Custom logging
The first step is to create a data model that we want to save into DB.

Error log Data model
These are few properties to do logging which could be extended or reduced based on need.

public class ErrorLog { /// <summary> /// Gets or sets the Error log identifier. /// </summary> /// <value> /// The Error log identifier. /// </value> [BsonRepresentation(BsonType.ObjectId)] public ObjectId Id { get; set; /// <summary> /// Gets or sets the date. /// </summary> /// <value> /// The date. /// </value> public DateTime Date { get; set; } /// <summary> /// Gets or sets the thread. /// </summary> /// <v…

Custom authorization on class, action/function, code, area level under Asp.Net MVC application

With evolution of ASP.Net MVC there are lot of inbuilt feature came and evolved with time. One of those is Authorization and Custom Authorization. The in-built function is sufficient enough to handle anonymous user restriction, user based on there name, specific roles for user with just single class AuthorizeAttribute.
To implement we need to decorate attribute on any given class, action based on need.

[Authorize] public ActionResult Test() { }
By just providing Authorize attribute anonymous user are restricted. It has Roles and Users property parameters to restrict access based on certain role or user which can accept multiple values by comma separated as string format.

In one of the situation, I got chance to built an authorization where roles keep changing. Administrator can add new role, delete any role or modify existing role. In that situation we cannot map roles with codes. So, there were two way to achieve by creating group of roles and letting administra…

Kendo MVC Grid DataSourceRequest with AutoMapper

Kendo Grid does not work directly with AutoMapper but could be managed by simple trick using mapping through ToDataSourceResult. The solution works fine until different filters are applied.
The problems occurs because passed filters refer to view model properties where as database model properties are required after AutoMapper is implemented.
So, the plan is to intercept DataSourceRequest  and modify names based on database model. To do that we are going to create implementation of CustomModelBinderAttribute to catch calls and have our own implementation of DataSourceRequestAttribute from Kendo MVC. I will be using same source code from Kendo but will replace column names for different criteria for sort, filters, group etc.
Let's first look into how that will be implemented.
public ActionResult GetRoles([MyDataSourceRequest(GridId.RolesUserGrid)] DataSourceRequest request) { if (request == null) { throw new ArgumentNullException("reque…

T4, Generating interface automatically based on provided classes

With new techniques and patterns interface plays a key role in application architecture. Interface makes application extendable like defining file upload interface and implementing based on file system, Azure Blob storage, Amazon S3. At starting we might be implementing based on Azure Blob but later we might move to Windows based file system and so on.

Ideally we create interface based on need and start implementing actual default implementation class. Many a times at starting of implementation there is one to one mapping between Interface and Class. Like from above example File upload interface and the initial or default class implementation that we design and with time it will get extended.
In this article, we will try to create interface based on default class implementation. This is not at all recommended in Test Driven Design (TDD) where we test the application before actual code implementation but I feel sometimes and in some situations it is okay do that and test straight afte…