Manually invoking ModelState validation

Question

I'm using ASP.NET MVC 3 code-first and I have added validation data annotations to my models. Here's an example model:

public class Product
{
    public int ProductId { get; set; }

    [Required(ErrorMessage = "Please enter a name")]
    public string Name { get; set; }

    [Required(ErrorMessage = "Please enter a description")]
    [DataType(DataType.MultilineText)]
    public string Description { get; set; }

    [Required(ErrorMessage = "Please provide a logo")]
    public string Logo { get; set; }
}

In my website I have a multi-step process to create a new product - step 1 you enter product details, step 2 other information etc. Between each step I'm storing each object (i.e. a Product object) in the Session, so the user can go back to that stage of the process and amend the data they entered.

On each screen I have client-side validation working with the new jQuery validation fine.

The final stage is a confirm screen after which the product gets created in the database. However because the user can jump between stages, I need to validate the objects (Product and some others) to check that they have completed the data correctly.

Is there any way to programatically call the ModelState validation on an object that has data annotations? I don't want to have to go through each property on the object and do manual validation.

I'm open to suggestions of how to improve this process if it makes it easier to use the model validation features of ASP.NET MVC 3.

Solution 1

You can call the ValidateModel method within a Controller action (documentation here).

Solution 2

ValidateModel and TryValidateModel

You can use ValidateModel or TryValidateModel in controller scope.

When a model is being validated, all validators for all properties are run if at least one form input is bound to a model property. The ValidateModel is like the method TryValidateModel except that the TryValidateModel method does not throw an InvalidOperationException exception if the model validation fails.

ValidateModel - throws exception if model is not valid.

TryValidateModel - returns bool value indicating if model is valid.

class ValueController : Controller
{
    public IActionResult Post(MyModel model)
    {
        if (!TryValidateModel(model))
        {
            // Do something
        }

        return Ok();
    }
}

Validate Models one-by-one

If you validate a list of models one by one, you would want to reset ModelState for each iteration by calling ModelState.Clear().

Link to the documentation

Solution 3

I found this to work and do precisely as expected.. showing the ValidationSummary for a freshly retrieved object on a GET action method... prior to any POST

Me.TryValidateModel(MyCompany.OrderModel)

Solution 4

            //
            var context = new ValidationContext(model);

            //If you want to remove some items before validating
            //if (context.Items != null && context.Items.Any())
            //{
            //    context.Items.Remove(context.Items.Where(x => x.Key.ToString() == "Longitude").FirstOrDefault());
            //    context.Items.Remove(context.Items.Where(x => x.Key.ToString() == "Latitude").FirstOrDefault());
            //}

            List<ValidationResult> validationResults = new List<ValidationResult>();
            bool isValid = Validator.TryValidateObject(model, context, validationResults, true);
            if (!isValid)
            {
                //List of errors 
                //validationResults.Select(r => r.ErrorMessage)
                //return or do something
            }

View more solutions

Comments

[Sam Huggill]

Thanks, I used TryUpdateModel() in the end so I didn't have exceptions raised.

[Ricardo França]

I have a Required field that is null and used "ModelState.Clear()" and the ModelState.IsValid is true.

[Ricardo França]

It works when I put "ModelState.Clear();" and "TryValidateModel(myModel);". Thanks

[Jess]

This may seem obvious after you think about it, but your custom Validate method will not be called if there are any validation errors within the validation attributes.