Support us .Net Basics C# SQL ASP.NET Aarvi MVC Slides C# Programs Subscribe Download

Part 91 - Create a custom remote attribute and override IsValid() method

Suggested Videos 
Part 88 - Unobtrusive validation
Part 89 - Remote validation in asp.net mvc
Part 90 - Remote validation in mvc when javascript is disabled



Please watch Part 90 from asp.net mvc tutorial, before proceeding.

Out of the box, Remote attribute only works when JavaScript is enabled. If the end user, disables JavaScript on his/her machine then the validation does not work. This is because RemoteAttribute requires JavaScript to make an asynchronous AJAX call to the server side validation method. As a result, the user will be able to submit the form, bypassing the validation in place. This why it is always important to have server side validation.



To make server side validation work, when JavaScript is disabled, there are 2 ways
1. Add model validation error dynamically in the controller action method - Discussed in Part 90
2. Create a custom remote attribute and override IsValid() method

In this video, we will discuss, creating a custom remote attribute
Step 1: Right click on the project name in solution explorer and a folder with name = "Common"

Step 2: Right click on the "Common" folder, you have just added and add a class file with name = RemoteClientServer.cs

Step 3: Copy and paste the following code. 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using System.ComponentModel.DataAnnotations;
using System.Reflection;

namespace MVCDemo.Common
{
    public class RemoteClientServerAttribute : RemoteAttribute
    {
        protected override ValidationResult IsValid(object value, ValidationContext validationContext)
        {
            // Get the controller using reflection
            Type controller = Assembly.GetExecutingAssembly().GetTypes()
                .FirstOrDefault(type => type.Name.ToLower() == string.Format("{0}Controller"
                    this.RouteData["controller"].ToString()).ToLower());
            if (controller != null)
            {
                // Get the action method that has validation logic
                MethodInfo action = controller.GetMethods()
                    .FirstOrDefault(method => method.Name.ToLower() == 
                        this.RouteData["action"].ToString().ToLower());
                if (action != null)
                {
                    // Create an instance of the controller class
                    object instance = Activator.CreateInstance(controller);
                    // Invoke the action method that has validation logic
                    object response = action.Invoke(instance, new object[] { value });
                    if (response is JsonResult)
                    {
                        object jsonData = ((JsonResult)response).Data;
                        if (jsonData is bool)
                        {
                            return (bool)jsonData ? ValidationResult.Success : 
                                new ValidationResult(this.ErrorMessage);
                        }
                    }
                }
            }

            return ValidationResult.Success;
            // If you want the validation to fail, create an instance of ValidationResult
            // return new ValidationResult(base.ErrorMessageString);
        }

        public RemoteClientServerAttribute(string routeName)
            : base(routeName)
        {
        }

        public RemoteClientServerAttribute(string action, string controller)
            : base(action, controller)
        {
        }

        public RemoteClientServerAttribute(string action, string controller, 
            string areaName) : base(action, controller, areaName)
        {
        }
    }
}

Step 4: Open "User.cs" file, that is present in "Models" folder. Decorate "UserName" property with RemoteClientServerAttribute. 

RemoteClientServerAttribute is in MVCDemo.Common namespace, so please make sure you have a using statement for this namespace.
public class UserMetadata
{
    [RemoteClientServer("IsUserNameAvailable", "Home"
        ErrorMessage="UserName already in use")]
    public string UserName { get; set; }
}

Disable JavaScript in the browser, and test your application. Notice that, we don't get client side validation, but when you submit the form, server side validation still prevents the user from submitting the form, if there are validation errors.

6 comments:

  1. Sir, Thanks for your excellent video tutorial. But in custom remote validation when I use any session objects it is always returns null. Another problem is also there if I use multiple submit button like (Select & Create) and on multiple submit request button name returns null. Is it a bug from .Net or is there any extra settings required? Please help. Thanks in advance.

    ReplyDelete
  2. Thanks for this excellent video tutorial. Really helps me to use Remote Attribute with or without javascript enabled.

    Please continue your great work!

    ReplyDelete
  3. This comment has been removed by the author.

    ReplyDelete
  4. There is a problem in this method! If I use it in any CRUD operation, then it does not work in case of Edit/Updating of any existing value. It does not allow to pass the original value of Unique Property on Edit/Update..Please correct the problem please..

    ReplyDelete
  5. This method works fine in case of Creating new entity but does not work properly in case of Edit/Updating any existing entity. It does not allow to pass the original value of unique field while updating the other fields.

    ReplyDelete
  6. Thanks for this wonderful video, But if we want to get this error message from Database then what will have to do?, Please suggest.

    ReplyDelete

It would be great if you can help share these free resources