MVC unobtrusive validation on checkbox not working
Sniffer,
In addition to implementing Darin's solution, you also need to modify the file jquery.validate.unobtrusive.js
. In this file, you must add a "mustbetrue" validation method, as follows:
$jQval.addMethod("mustbetrue", function (value, element, param) {
// check if dependency is met
if (!this.depend(param, element))
return "dependency-mismatch";
return element.checked;
});
Then (I forgot to add this at first), you must also add the following to jquery.validate.unobtrusive.js
:
adapters.add("mustbetrue", function (options) {
setValidationValues(options, "mustbetrue", true);
});
counsellorben
You need to implement IClientValidatable on your custom attribute in order to tie the mustbetrue
adapter name that you are registering on the client side with this attribute:
[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
public class MustBeTrueAttribute : ValidationAttribute, IClientValidatable
{
public override bool IsValid(object value)
{
return value != null && value is bool && (bool)value;
}
public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context)
{
yield return new ModelClientValidationRule
{
ErrorMessage = this.ErrorMessage,
ValidationType = "mustbetrue"
};
}
}
UPDATE:
Full working example.
Model:
public class MyViewModel
{
[MustBeTrue(ErrorMessage = "You must accept the terms and conditions")]
[DisplayName("Accept terms and conditions")]
public bool AcceptsTerms { get; set; }
}
Controller:
public class HomeController : Controller
{
public ActionResult Index()
{
var model = new MyViewModel();
return View(model);
}
[HttpPost]
public ActionResult Index(MyViewModel model)
{
return View(model);
}
}
View:
@model MyViewModel
<script src="@Url.Content("~/Scripts/jquery.validate.js")" type="text/javascript"></script>
<script src="@Url.Content("~/Scripts/jquery.validate.unobtrusive.js")" type="text/javascript"></script>
<script type="text/javascript">
$.validator.unobtrusive.adapters.addBool("mustbetrue", "required");
</script>
@using (Html.BeginForm())
{
@Html.CheckBoxFor(x => x.AcceptsTerms)
@Html.LabelFor(x => x.AcceptsTerms)
@Html.ValidationMessageFor(x => x.AcceptsTerms)
<input type="submit" value="OK" />
}
I'm unsure why this didn't work for me, but I opted to use your code and do something slightly different.
On my JavaScript load I add the following, this makes the checkbox fire the unabtrusive validation if, either you select the checkbox and uncheck it. Also, if you submit the form.
$(function () {
$(".checkboxonblurenabled").change(function () {
$('form').validate().element(this);
});
});
You also need to add the CSS class to your checkbox, like so.
@Html.CheckBoxFor(model => model.AgreeToPrivacyPolicy, new { @class = "checkboxonblurenabled"})
So, we now need to hook up the model and put in out class to handle the server side validation (which i'm re-using from above) but changing the unobtrusiveness slightly.
Here's the customer attribute that extends IClientValidate as in the above example...
[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
public class MustBeTrueAttribute : ValidationAttribute, IClientValidatable
{
public override bool IsValid(object value)
{
return value != null && value is bool && (bool)value;
}
public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context)
{
yield return new ModelClientValidationRule
{
ErrorMessage = this.ErrorMessage,
ValidationType = "mustbetrue"
};
}
}
In your model, object property set the desired attribute notations
[MustBeTrue(ErrorMessage = "Confirm you have read and agree to our privacy policy")]
[Display(Name = "Privacy policy")]
public bool AgreeToPrivacyPolicy { get; set; }
Okay, we're ready to put in the JavaScript.
(function ($) {
/*
START CHECK MUST BE TRUE - UNOBTRUSIVE JAVASCRIPT
START CHECK MUST BE TRUE - UNOBTRUSIVE JAVASCRIPT
START CHECK MUST BE TRUE - UNOBTRUSIVE JAVASCRIPT
*/
jQuery.validator.unobtrusive.adapters.add("mustbetrue", ['maxint'], function (options) {
options.rules["mustbetrue"] = options.params;
options.messages["mustbetrue"] = options.message;
});
jQuery.validator.addMethod("mustbetrue", function (value, element, params) {
if ($(element).is(':checked')) {
return true;
}
else {
return false;
}
});
/*
START CHECK MAX INT - UNOBTRUSIVE JAVASCRIPT
START CHECK MAX INT - UNOBTRUSIVE JAVASCRIPT
START CHECK MAX INT - UNOBTRUSIVE JAVASCRIPT
*/
} (jQuery));
What makes this work, is... well. After looking at the HTML markup after trying to do the suggested answer above, my values were all set to true, however my checkbox checked was false. So, I decided to let jQuery work it out using IsChecked