Custom Validation and Class Level validation using Data Annotation in MVC .Net core application

-

 In Previous article i have demonstrated about "Validations using entity framework data annotation in .Net core MVC" where i have implemented ready made validation types in MVC application. In this article i will be demonstrating about custom validation and class level validation using Data Annotation in MVC .Net core application. The custom validation will be very useful when we need to solve real time scenario where the ready made validation will not work. I also going to show about the class level validation which is also a type of custom kind validation available in data annotation using entity framework.



Lets start the implementation, I going to use the same application which i have used in previous article.

First we need to add few columns in existing employee table for validation demonstration as below.

  1. DateOfBirth
  2. DateOfJoin
  3. DateOfExit 

After adding above fields my model class will look like below


 using ModelsExample.Attributes;  
 using System;  
 using System.Collections.Generic;  
 using System.ComponentModel.DataAnnotations;  
 using System.ComponentModel.DataAnnotations.Schema;  
 namespace ModelsExample  
 {  
   [Table("EmployeeMaster")]  
   public class Employee:IValidatableObject  
   {  
     [Column("Id")]  
     public int Id { get; set; }  
     [Column("Name")]  
     [Required(ErrorMessage = "Please enter Name")]  
     [MaxLength(25,ErrorMessage ="Maximum 25 characters allowed")]  
     [RegularExpression(@"^[a-zA-Z0-9]{4,10}$",ErrorMessage ="Special characters not allowed in Name")]  
     public string Name { get; set; }  
     [Column("Address")]  
     [Required(ErrorMessage = "Please enter Address")]  
     [StringLength(200, ErrorMessage ="{0} length must be between {2} and {1}",MinimumLength =6)]  
     public string Address { get; set; }  
     [Column("CityId")]  
     [Required(ErrorMessage = "Please Select City")]  
     public int CityId { get; set; }  
     [Column("StateId")]  
     [Required(ErrorMessage = "Please Select State")]      
     public int StateId { get; set; }  
     [Column("DateOfBirth")]    
     [Required(ErrorMessage = "Please enter Date of Birth")]  
     public DateTime DateOfBirth { get; set; }  
     [Column("DateOfJoin")]  
     [Required(ErrorMessage = "Please enter Date of Join")]   
     public DateTime DateOfJoin { get; set; }  
     [Column("DateOfExit")]  
     public DateTime? DateOfExit { get; set; }  
   }  
 }

 after adding below field i need to execute below migration command in package manager console window 


 add-migration "AddedDateFieldsInEmployeeMaster"

Once executing above command migration below file got generated.

 

 

 using System;  
 using Microsoft.EntityFrameworkCore.Migrations;  
 namespace ModelsExample.Migrations  
 {  
   public partial class AddedDateFieldsInEmployeeMaster : Migration  
   {  
     protected override void Up(MigrationBuilder migrationBuilder)  
     {  
       migrationBuilder.AlterColumn<string>(  
         name: "Name",  
         table: "EmployeeMaster",  
         maxLength: 25,  
         nullable: false,  
         oldClrType: typeof(string),  
         oldType: "nvarchar(max)",  
         oldNullable: true);  
       migrationBuilder.AlterColumn<string>(  
         name: "Address",  
         table: "EmployeeMaster",  
         maxLength: 200,  
         nullable: false,  
         oldClrType: typeof(string),  
         oldType: "nvarchar(max)",  
         oldNullable: true);  
       migrationBuilder.AddColumn<DateTime>(  
         name: "DateOfBirth",  
         table: "EmployeeMaster",  
         nullable: false,  
         defaultValue: new DateTime(1, 1, 1, 0, 0, 0, 0, DateTimeKind.Unspecified));  
       migrationBuilder.AddColumn<DateTime>(  
         name: "DateOfExit",  
         table: "EmployeeMaster",  
         nullable: true);  
       migrationBuilder.AddColumn<DateTime>(  
         name: "DateOfJoin",  
         table: "EmployeeMaster",  
         nullable: false,  
         defaultValue: new DateTime(1, 1, 1, 0, 0, 0, 0, DateTimeKind.Unspecified));  
     }  
     protected override void Down(MigrationBuilder migrationBuilder)  
     {  
       migrationBuilder.DropColumn(  
         name: "DateOfBirth",  
         table: "EmployeeMaster");  
       migrationBuilder.DropColumn(  
         name: "DateOfExit",  
         table: "EmployeeMaster");  
       migrationBuilder.DropColumn(  
         name: "DateOfJoin",  
         table: "EmployeeMaster");  
       migrationBuilder.AlterColumn<string>(  
         name: "Name",  
         table: "EmployeeMaster",  
         type: "nvarchar(max)",  
         nullable: true,  
         oldClrType: typeof(string),  
         oldMaxLength: 25);  
       migrationBuilder.AlterColumn<string>(  
         name: "Address",  
         table: "EmployeeMaster",  
         type: "nvarchar(max)",  
         nullable: true,  
         oldClrType: typeof(string),  
         oldMaxLength: 200);  
     }  
   }  
 }

 Once running the application the columns will be created by auto-migration code which i had explained in my previous article.

 

Custom Validation Using Attributes:

so now lets move to create custom migration attribute class for our custom validation.

First we need to create the Attributes folder in ModelExample Project and inside the attributes folder add class named "EmployeeAgeCompliance.cs" and add below code in that.

project structure


 using System;  
 using System.Collections.Generic;  
 using System.ComponentModel.DataAnnotations;  
 using System.Text;  
 namespace ModelsExample.Attributes  
 {  
   public class EmployeeAgeCompliance:ValidationAttribute  
   {  
     protected override ValidationResult IsValid(object value, ValidationContext validationContext)  
     {  
       DateTime dob = Convert.ToDateTime(value);  
       if (DateTime.Now.Subtract(dob).TotalDays < 6570)  
       {  
         return new ValidationResult("The given date of birth is not complient and empoloyee is not 18 years completed");   
       }  
       return ValidationResult.Success;  
     }  
   }  
 }

In above code we have checked that the the employee age should be more than or equal to 18 years other wise the user will get the validation message in return statement. Now we have created the attribute now its time to use this attribute in the model as per below highlighted code.


 using ModelsExample.Attributes;  
 using System;  
 using System.Collections.Generic;  
 using System.ComponentModel.DataAnnotations;  
 using System.ComponentModel.DataAnnotations.Schema;  
 namespace ModelsExample  
 {  
   [Table("EmployeeMaster")]  
   public class Employee:IValidatableObject  
   {  
     [Column("Id")]  
     public int Id { get; set; }  
     [Column("Name")]  
     [Required(ErrorMessage = "Please enter Name")]  
     [MaxLength(25,ErrorMessage ="Maximum 25 characters allowed")]  
     [RegularExpression(@"^[a-zA-Z0-9]{4,10}$",ErrorMessage ="Special characters not allowed in Name")]  
     public string Name { get; set; }  
     [Column("Address")]  
     [Required(ErrorMessage = "Please enter Address")]  
     [StringLength(200, ErrorMessage ="{0} length must be between {2} and {1}",MinimumLength =6)]  
     public string Address { get; set; }  
     [Column("CityId")]  
     [Required(ErrorMessage = "Please Select City")]  
     public int CityId { get; set; }  
     [Column("StateId")]  
     [Required(ErrorMessage = "Please Select State")]      
     public int StateId { get; set; }  
     [Column("DateOfBirth")]  
     [EmployeeAgeCompliance()]  
     [Required(ErrorMessage = "Please enter Date of Birth")]  
     public DateTime DateOfBirth { get; set; }  
     [Column("DateOfJoin")]  
     [Required(ErrorMessage = "Please enter Date of Join")]   
     public DateTime DateOfJoin { get; set; }  
     [Column("DateOfExit")]  
     public DateTime? DateOfExit { get; set; }  
   }  
 }

Next we have add new fields added in our view so that user can put input and we can test our validation.

Below is our modified SaveEmployee.Chtml file with highlighted text.


 @*  
   For more information on enabling MVC for empty projects, visit https://go.microsoft.com/fwlink/?LinkID=397860  
 *@  
 @using ModelsExample  
 @model Employee  
 @{  
 }  
 @section Scripts  
 {  
   @Html.Partial("_ValidationScriptsPartial")  
   <script type="text/javascript">  
     $(document).ready(function () {  
       $("#StateId").change(function () {  
         var stateId = $(this).val();  
         $.get("/MasterData/GetCity?StateId=" + stateId, function (data) {  
           var city = $("#CityId");  
           city.html('');  
           city.append($("<option/>", { value: "", text: "Select" }));  
           if (data && data.length > 0) {  
             $.each(data, function (index, item) {  
               city.append($("<option/>", { value: item.id, text: item.name }));  
             });  
           }  
         });  
       });  
       $.each($("input"), function (n, e) {  
         e.value = e.value.replace("01-01-0001 00:00:00", "");  
       });  
     });  
   </script>  
   <style type="text/css">  
     .field-validation-error {  
       color: red;  
       font-weight: bold;  
     }  
   </style>  
 }  
 @using (Html.BeginForm())  
 {  
   <h1>Enter Employee Details</h1>  
   <div>  
     @Html.LabelFor(model => model.Name)  
   </div>  
   <div>  
     @Html.TextBoxFor(model => model.Name)  
     @Html.ValidationMessageFor(model => model.Name)  
   </div>  
   <div>  
     @Html.LabelFor(model => model.Address)  
   </div>  
   <div>  
     @Html.TextBoxFor(model => model.Address)  
     @Html.ValidationMessageFor(model => model.Address)  
   </div>  
   <div>  
     @Html.LabelFor(model => model.StateId)  
   </div>  
   <div>  
     @Html.DropDownListFor(model => model.StateId, new SelectList(ViewBag.StateMaster, "Id", "Name", 0), "Select")  
     @Html.ValidationMessageFor(model => model.StateId)  
   </div>  
   <div>  
     @Html.LabelFor(model => model.CityId)  
   </div>  
   <div>  
     @Html.DropDownListFor(model => model.CityId, new SelectList(ViewBag.CityMaster??Enumerable.Empty<SelectListItem>(), "Id", "Name", 0), "Select")  
     @Html.ValidationMessageFor(model => model.CityId)  
   </div>  
   <div>  
     @Html.LabelFor(model => model.DateOfBirth)  
   </div>  
   <div>  
     @Html.TextBoxFor(model => model.DateOfBirth)  
     @Html.ValidationMessageFor(model => model.DateOfBirth)  
   </div>  
   <div>  
     @Html.LabelFor(model => model.DateOfJoin)  
   </div>  
   <div>  
     @Html.TextBoxFor(model => model.DateOfJoin)  
     @Html.ValidationMessageFor(model => model.DateOfJoin)  
   </div>  
   <div>  
     @Html.LabelFor(model => model.DateOfExit)  
   </div>  
   <div>  
     @Html.TextBoxFor(model => model.DateOfExit)  
     @Html.ValidationMessageFor(model => model.DateOfExit)  
   </div>  
   <hr />  
   <div>  
     <input type="submit" value="Submit" /> @Html.ActionLink("Back to employees", "Index")  
   </div>  
 }

 

Now we need to modify our employee controller file to check for "ModelState.IsValid" property when user submits the form id the "ModelState.IsValid" is true then only we need to save the data to db else we will return the same view with model object like below code.


 using BusinessLayerExample.Definition;  
 using Microsoft.AspNetCore.Mvc;  
 using ModelsExample;  
 namespace Project_structiure_Example.Controllers  
 {  
   public class EmployeeController : Controller  
   {  
     public readonly IEmployeeService employeeService;  
     public readonly IMasterService masterService;  
     public EmployeeController(IEmployeeService employeeServiceObj,IMasterService masterService)  
     {  
       employeeService = employeeServiceObj;  
       this.masterService = masterService;  
     }  
     public IActionResult Index()  
     {  
       var employees = employeeService.GetEmplyees();  
       return View(employees);  
     }  
     [HttpGet]  
     public IActionResult SaveEmployee()  
     {  
       ViewBag.StateMaster= masterService.GetStateMaster();  
       return View(new Employee());  
     }  
     [HttpPost]  
     public IActionResult SaveEmployee(Employee employee)  
     {  
       bool result = false;  
       if (ModelState.IsValid)  
       {  
         result = employeeService.SaveEmployee(employee);  
       }  
       if(result)  
       {  
         return RedirectToAction("Index");  
       }  
       else  
       {  
         ViewBag.StateMaster = masterService.GetStateMaster();  
         ViewBag.CityMaster = masterService.GetCityMaster(employee.StateId);  
         return View(employee);  
       }  
     }  
     [HttpGet]  
     public IActionResult UpdateEmployee(int id)  
     {  
       var employee = employeeService.GetEmplyees(id);  
       return View(employee);  
     }  
     [HttpPost]  
     public IActionResult UpdateEmployee(Employee employee)  
     {  
       bool result = false; ;  
       if (ModelState.IsValid)  
       {  
          result = employeeService.UpdateEmployee(employee);  
       }  
       if (result)  
       {  
         return RedirectToAction("Index");  
       }  
       else  
       {  
         ViewBag.StateMaster = masterService.GetStateMaster();  
         ViewBag.CityMaster = masterService.GetCityMaster(employee.StateId);  
         return View(employee);  
       }  
     }  
     [HttpGet]  
     public IActionResult DeleteEmployee(int id)  
     {  
       var employee = employeeService.GetEmplyees(id);  
       return View(employee);  
     }  
     [HttpPost]  
     public IActionResult DeleteEmployee(int id,Employee emp)  
     {  
       var result = employeeService.DeleteEmployee(id);  
       if (result)  
       {  
         return RedirectToAction("Index");  
       }  
       else  
       {  
         return View(emp);  
       }  
     }  
   }  
 }

 Now this custom validation code is done lets run the application and check for output as below.

 

custom validation sample

 in above image you can see that the validation is showing if user put date which is not satisfying the condition of 18 years.


Class level validation:

I have shown custom validation using attributes now we can have look in class level validation technique. In class level validation we need to implement IValidatableObject interface to our model class in our case it is Employee model. like below highlighted code.


 using ModelsExample.Attributes;  
 using System;  
 using System.Collections.Generic;  
 using System.ComponentModel.DataAnnotations;  
 using System.ComponentModel.DataAnnotations.Schema;  
 namespace ModelsExample  
 {  
   [Table("EmployeeMaster")]  
   public class Employee:IValidatableObject  
   {  
     [Column("Id")]  
     public int Id { get; set; }  
     [Column("Name")]  
     [Required(ErrorMessage = "Please enter Name")]  
     [MaxLength(25,ErrorMessage ="Maximum 25 characters allowed")]  
     [RegularExpression(@"^[a-zA-Z0-9]{4,10}$",ErrorMessage ="Special characters not allowed in Name")]  
     public string Name { get; set; }  
     [Column("Address")]  
     [Required(ErrorMessage = "Please enter Address")]  
     [StringLength(200, ErrorMessage ="{0} length must be between {2} and {1}",MinimumLength =6)]  
     public string Address { get; set; }  
     [Column("CityId")]  
     [Required(ErrorMessage = "Please Select City")]  
     public int CityId { get; set; }  
     [Column("StateId")]  
     [Required(ErrorMessage = "Please Select State")]      
     public int StateId { get; set; }  
     [Column("DateOfBirth")]  
     [EmployeeAgeCompliance()]  
     [Required(ErrorMessage = "Please enter Date of Birth")]  
     public DateTime DateOfBirth { get; set; }  
     [Column("DateOfJoin")]  
     [Required(ErrorMessage = "Please enter Date of Join")]   
     public DateTime DateOfJoin { get; set; }  
     [Column("DateOfExit")]  
     public DateTime? DateOfExit { get; set; }  
     public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)  
     {  
       List<ValidationResult> validationResults = new List<ValidationResult>();  
       if(DateOfJoin>DateOfExit)  
       {  
         validationResults.Add(new ValidationResult("date of exit should be greater than date of join", new string[] { nameof(DateOfExit) }));  
       }  
       return validationResults;  
     }  
   }  
 }

In above code we have checked dateofexit should not be less than join date if user puts the same scenario then user will get the message mentioned in validationresult class custructer and second parameter of validationresult will be for implementing this validation on which field. Like this you can put n number of validation in this method and add the validationresult object to validationResults List object and then finally return it.We have added the the validation now lets check the output for the class level validation.


class level validation

Like above approch you can easily implement the custom validation in your MVC .net core application.



 

Comments

  1. Robert JamesFebruary 8, 2023 at 5:09 AM

    Unquestionably generally speaking very intriguing post. I was looking for Dot net Coaching and totally savored the experience of examining this one. Keep on posting. A responsibility of appreciation is all together for sharing.

    ReplyDelete

Post a Comment

Popular posts from this blog

Implement Logging in CSV file using Nlog in .net core MVC application- part 2

-
Image
In previous article " Implement Nlog in .Net core MVC application part 1 "  I have demonstrated how we can implement basic setup of NLog in .core mvc application. In previous article we have logged the exceptions in flat file system. In this article I will show you how you can write the exception and custom logs in csv file. Writing logs in csv file can enable us better readability of logs in tabular form.       Lets start the implementation of it, I going to use the same example project used in previous demonstration. Modify the Nlog.config file as follows, added new target and rule for logging logs in csv file. <?xml version="1.0" encoding="utf-8" ?> <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd" autoReload="true" throwExceptions="fal
Read more

Implement Nlog in .Net core MVC application part 1

-
Image
Logging is a very important part of the enterprise application/web application. Setting up the logging correctly not only beneficial for long term maintenance of the application but also it is useful tool to find out the RCA in case of mission critical bug arises. Therefor we will going to discuss the various logging technique implementation using Nlog library package. In this article we will going to use .net core application for demonstration but you can implement it in .net framework application also. So lets start the implementation of Nlog in .net core MVC application. Open visual studio 2019/17 and create the new project as shown below.     Select Asp.net core Web App (Model-View-Controller) and provide the project name in project name text box.   Now on next screen click on create button this will create MVC app with .net core Now go to solution explorer and right click on project and click on Manage Nuget Package. Now in Nuget package manager install below listed Nlog packages.
Read more

Angular User Session Timeout example step by step

-
Image
This functionality let the user know that their session is about to expire and that they would be logged out if they didn’t take action. I have written this functionality in Angular for my latest application.  If you are new to Angular 6 then read my article about Setting up Angular 6 step by step before jump to this article to get handy in Angular 6. Dealing with timers in Angular can be significantly different when using React components and subscriptions. The basic premises remains the same, though. We’ll have a service with a timer that will provide a Subject to which consumers of the service can subscribe. A React Subject provides an easy mechanism to trigger a “next” subscription to alert consumers that the timer has expired.   import { Injectable } from '@angular/core'; import { Observable, Subject, Subscription, BehaviorSubject} from 'rxjs/Rx'; @Injectable() export class IdleTimeoutService { private _count: number = 0;
Read more

Disable backspace key using Jquery

-
Disable backspace key in HTML form using Jquery in simple steps. While user enters data into application if user accidentally  press backspace button then it will redirect to previous page and all entered data would be lost. to eliminate this event we can disable the backspace key using Jquery. Following is the JQuery script tag you can add to the web page $(document).keydown(function (e) { var nodeName = e.target.nodeName.toLowerCase(); if (e.which === 8) { if ((nodeName === 'input' && e.target.type === 'text') || nodeName === 'textarea') { // do nothing } else { e.preventDefault(); } } }); The above code can be used seamlessly with any web technology you are using. Hope this will help you in your web application. Happy coding:)
Read more

Devexpress Datebox date formatting in angular 6 with example

-
The Devexpress DateBox in Angular is a widget that displays the date and time in one of DevExtreme predefined formats or a format defined in an external localization library, or a type in the required date/time value. In this article, the i will provide you different date-format which we can set on DateBox to show date and time to user. Following is the code snippet to add Datebox in your Angular form if the you want to capture only date      <dx-date-box [value]="now" displayFormat="EEEE, MMM dd" type="date" > </dx-date-box> Following is the custom formats we can set and depending upon its converted values will be shown. "dd-MM-yyyy" => 28-10-2018 "EEEE, MMM dd" => Sunday, Oct 28 "dd MMM yyyy EEEE" => 28 Oct 2018 Sunday "dd-MM-yyyy EEEE" => 28-10-2018 Sunday alternatively you can change the format as way you want Following is
Read more