Skip to main content

Client side Validation for data driven view engine

The prerequisite for this is to have a designed database driven view engine. This can be a good guidance to implement DB driven view engine Data Driven Custom View Engine in ASP.NET MVC (http://www.dotnetcurry.com/aspnet-mvc/946/data-driven-custom-view-engine-aspnet-mvc).

If we talk about the concept then we can say for DB driven view engine a dynamic form/screen table would require along with the associate attribute set for controls. The controls, Attribute set can have constraints like Required, MaxLength, RegEx etc. similar to available DataAnnotation implementation, just that it has to come through DB.

The jQuery unobtrusive validation is all about adding certain HTML 5 data attributes. So, if we can find rules of the controls (required, max length etc) and set it to HTML attribute from view engine then we are done.

While designing DB driven view engine, there should be a place where we need to loop through available controls to identify it's type and write as HTML/element. A common attribute set can be applied to all controls including the validation rule.

This  would allow us to get key value validation attributes.

 /// <summary>  
 /// Gets the unobtrusive validation attributes.  
 /// </summary>  
 /// <param name="control">The field for dynamic controls.</param>  
 /// <returns>Validation attributes wrapped in Dictionary.</returns>  
 private IDictionary<string, object> GetUnobtrusiveValidationAttributes(AttributeSet control)  
 {  
      IDictionary<string, object> validationAttribs = new Dictionary<string, object>();  
      ModelMetadata metaData = ModelMetadata.FromStringExpression(GetFieldName(control), Helper.ViewData);  
      var clientValidator = new AttributeSetModelValidatorProvider(metaData, ControllerContext,  
           new MaxLengthAttribute(), // Dummy attribute passed  
           control);  
      UnobtrusiveValidationAttributesGenerator.GetValidationAttributes(clientValidator.GetClientValidationRules(), validationAttribs);  
      return validationAttribs;  
 }

The AttributeSetModelValidatorProvider is a custom class designed to get the validation configuration. The class inherits from DataAnnotationsModelValidator, there are certain parameters that need to be passed for initialization that is why few dummy data are passed. In general, it generates single validation rule but in our case, it has to be multiple rules.


The GetValidationAttributes method transforms into dictionary object. That dictionary object then can be applied to MVC controls.

The implementation of custom class:

 using System;  
 using System.Collections.Generic;  
 using System.ComponentModel.DataAnnotations;  
 using System.Web.Mvc;  
 /// <summary>  
 /// Data annotation model provider for dynamic controls  
 /// </summary>  
 public class AttributeSetModelValidatorProvider  
 : DataAnnotationsModelValidator  
 {  
   /// <summary>  
   /// The dynamic control for generating validation rules.  
   /// </summary>  
   private readonly AttributeSet Control;  
   /// <summary>  
   /// Initializes a new instance of the <see cref="AttributeSetModelValidatorProvider"/> class.  
   /// </summary>  
   /// <param name="metadata">The metadata.</param>  
   /// <param name="context">The context.</param>  
   /// <param name="attribute">The attribute.</param>  
   /// <param name="control">The dynamic control.</param>  
   public AttributeSetModelValidatorProvider(ModelMetadata metadata, ControllerContext context,  
     ValidationAttribute attribute, AttributeSet control)  
     : base(metadata, context, attribute)  
   {  
     Control = control;  
   }  
   /// <summary>  
   /// Retrieves a collection of client validation rules.  
   /// </summary>  
   /// <returns>  
   /// A collection of client validation rules.  
   /// </returns>  
   public override IEnumerable<ModelClientValidationRule> GetClientValidationRules()  
   {  
     var validationRules = new List<ModelClientValidationRule>();  
     #region " Different client side validation rule for dynamic controls "  
     if (Control.IsFieldValueRequired)  
     {  
       validationRules.Add(new ModelClientValidationRequiredRule(  
         String.Format("{0} cannot be empty.", Control.DisplayLabel)));  
     }  
     if (!String.IsNullOrEmpty(Control.ValidationRegEx))  
     {  
       validationRules.Add(new ModelClientValidationRegexRule(String.Format(  
         "Not a valid {0}", Control.DisplayLabel), Control.ValidationRegEx));  
     }  
     if (Control.MaxLength.HasValue && Control.MaxLength.Value > 0)  
     {  
       validationRules.Add(new ModelClientValidationMaxLengthRule(String.Format(  
         "{0} is having {1} allowed characters.", Control.DisplayLabel, Control.MaxLength), Control.MaxLength.Value));  
     }  
     if (Control.FieldName.ToLower().Contains("email"))  
     {  
       validationRules.Add(new ModelClientValidationRule()  
       {  
         ValidationType = "email",  
         ErrorMessage = "E Mail id is not valid."  
       });  
     }  
     ModelClientValidationRule dataType;  
     if (TryGettingTypeValidationRule(Control, out dataType))  
     {  
       validationRules.Add(dataType);  
     }  
     #endregion " Different client side validation rule for dynamic controls "  
     return validationRules;  
   }  
   /// <summary>  
   /// Try getting validation rule for dynamic control.  
   /// </summary>  
   /// <param name="dataField">The data field for dynamic control.</param>  
   /// <param name="dataTypeValidationRule">The data type validation rule.</param>  
   /// <returns>True, if Validation rule exist for dynamic control</returns>  
   private static bool TryGettingTypeValidationRule(AttributeSet dataField,  
     out ModelClientValidationRule dataTypeValidationRule)  
   {  
     dataTypeValidationRule = null;  
     var isSucess = false;  
     // Helper for creation object for validation rule  
     Func<string, string, ModelClientValidationRule> getValidationRule = (validationType, messageFormat) =>  
     {  
       return new ModelClientValidationRule  
       {  
         ValidationType = validationType,  
         ErrorMessage = String.Format(messageFormat, dataField.DisplayLabel)  
       };  
     };  
     // Rules based on data annotation and jQuery Unobtrusive validation  
     switch (dataField.FieldType.DisplayType)  
     {  
       case DbFieldType.ShortTime:  
       case DbFieldType.DateTime:  
       case DbFieldType.ShortDate:  
         dataTypeValidationRule = getValidationRule("date", "The field {0} must be a date.");  
         isSucess = true;  
         break;  
       case DbFieldType.Integer:  
       case DbFieldType.Decimal:  
       case DbFieldType.Money:  
       case DbFieldType.Percentage:  
         dataTypeValidationRule = getValidationRule("number", "The field {0} must be a number.");  
         isSucess = true;  
         break;  
     }  
     // Avoid type check for masked text boxes  
     if (!String.IsNullOrEmpty(dataField.MaskedTextFormat))  
     {  
       isSucess = false;  
     }  
     return isSucess;  
   }  
 }


The implementation is really simple, has to override GetClientValidationRules function which would return a list of ModelClientValidationRule. This list can have multiple rules like ModelClientValidationRegexRule, ModelClientValidationMaxLengthRule, etc. which are built in classes from MVC.
Labels:

Comments

Post a Comment

Popular posts from this blog

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 ...
4 comments
Read more

Centralized model validation both for MVC/WebApi and SPA client-side validation using FluentValidation

Validation is one of the crucial parts of any application. It has to validate on both client side and server side requests. What are target features or implementation from this article? Model validation for any given model. Centralized/One code for validation on both server-side and client-side. Automatic validation of model without writing any extra codes on/under actions for validation.  NO EXTRA/ANY codes on client-side to validate any form. Compatible with SPA. Can be compatible with any client-side validation framework/library. Like Angular Reactive form validation or any jquery validation libraries. Tools used in the implementation? FluentValidation : I feel DataAnnotation validation are excellent and simple to use, but in case of complex validation or writing any custom validations are always tricker and need to write a lot of codes to achieve whereas FluentValidations are simple even in case of complex validation. Generally, we need to validate inc...
2 comments
Read more

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"; });
1 comment
Read more

Trim text in MVC Core through Model Binder

Trimming text can be done on client side codes, but I believe it is most suitable on MVC Model Binder since it would be at one place on infrastructure level which would be free from any manual intervention of developer. This would allow every post request to be processed and converted to a trimmed string. Let us start by creating Model binder using Microsoft.AspNetCore.Mvc.ModelBinding; using System; using System.Threading.Tasks; public class TrimmingModelBinder : IModelBinder { private readonly IModelBinder FallbackBinder; public TrimmingModelBinder(IModelBinder fallbackBinder) { FallbackBinder = fallbackBinder ?? throw new ArgumentNullException(nameof(fallbackBinder)); } public Task BindModelAsync(ModelBindingContext bindingContext) { if (bindingContext == null) { throw new ArgumentNullException(nameof(bindingContext)); } var valueProviderResult = bindingContext.ValueProvider.GetValue(bin...
2 comments
Read more

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> ...
1 comment
Read more

Using Redis distributed cache in dotnet core with helper extension methods

Redis cache is out process cache provider for a distributed environment. It is popular in Azure Cloud solution, but it also has a standalone application to operate upon in case of small enterprises application. How to install Redis Cache on a local machine? Redis can be used as a local cache server too on our local machines. At first install, Chocolatey https://chocolatey.org/ , to make installation of Redis easy. Also, the version under Chocolatey supports more commands and compatible with Official Cache package from Microsoft. After Chocolatey installation hit choco install redis-64 . Once the installation is done, we can start the server by running redis-server . Distributed Cache package and registration dotnet core provides IDistributedCache interface which can be overrided with our own implementation. That is one of the beauties of dotnet core, having DI implementation at heart of framework. There is already nuget package available to override IDistributedCache i...
3 comments
Read more

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 Argume...
Post a Comment
Read more

Strongly typed SingalR on server and client end through TypeScript.

SignalR is a very flexible framework to create bidirectional communication between client and server. The general process that is followed won't allow to have strongly typed calls on the server and also in client code. We will look into how to make strongly typed calls on the server through interface and client end through TypeScript. SignalR - making strong type on server side code Since client-side methods are very dynamic in nature, so calling those from server side behaves similarly to allow any calls. SignalR Hubs are derived from Microsoft.AspNet.SignalR.Hub class, there is also a generic version available to follow typed items. Ex: The interface is the replication of possible calls that would be received on the client end and calling of client-side methods on server code. /// <summary> /// Client(JS) side chatting interface callbacks. /// </summary> public interface IChatHub { /// <summary> /// Gets the online users...
Post a Comment
Read more

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 ...
Post a Comment
Read more

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 t...
Post a Comment
Read more