Last active
September 12, 2017 11:37
-
-
Save rasmuseeg/3ca1630d45c54f485088 to your computer and use it in GitHub Desktop.
Umbraco MVC Data Annotations Attributes - Required, DisplayName, StringLength, MinLength, MaxLength etc.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
public class ContactFormModel | |
{ | |
[DictionaryDisplayName(nameof(CategoryId))] | |
[DictionaryRequired] | |
public int CategoryId { get; set; } | |
[DictionaryDisplayName(nameof(Subject))] | |
[DictionaryRequired] | |
[DictionaryMinLength(8)] | |
public string Subject { get; set; } | |
[DictionaryDisplayName(nameof(Message))] | |
[DictionaryRequired] | |
[DictionaryMinLength(8)] | |
[DictionaryStringLength(260, ResourceName = "CustomStringLengthError")] | |
public string Message { get; set; } | |
[DictionaryDisplayName("Email")] | |
[DictionaryRequired] | |
[DictionaryEmailAddress] | |
public string Email { get; set; } | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
using System; | |
using System.Collections.Generic; | |
using System.ComponentModel; | |
using System.ComponentModel.DataAnnotations; | |
using System.Globalization; | |
using System.Web.Mvc; | |
//Helping reference: https://github.com/mono/aspnetwebstack/blob/master/src/System.Web.Mvc/CompareAttribute.cs | |
namespace Umbraco.Web.DataAnnotations | |
{ | |
public class DictionaryDisplayNameAttribute : DisplayNameAttribute | |
{ | |
private readonly string resourceName; | |
public DictionaryDisplayNameAttribute(string resourceName) | |
: base() | |
{ | |
this.resourceName = resourceName; | |
} | |
public override string DisplayName | |
{ | |
get | |
{ | |
return UmbracoDictionary.GetDictionaryValue(resourceName); | |
} | |
} | |
} | |
public class DictionaryRequiredAttribute : RequiredAttribute, IClientValidatable | |
{ | |
public string ResourceName { get; set; } = "RequiredError"; | |
public DictionaryRequiredAttribute() : | |
base() | |
{ | |
} | |
public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context) | |
{ | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue(ResourceName); | |
yield return new ModelClientValidationRequiredRule(FormatErrorMessage(metadata.GetDisplayName())); | |
} | |
} | |
public class UmbracoStringLengthAttribute : StringLengthAttribute, IClientValidatable | |
{ | |
public UmbracoStringLengthAttribute(int maximumLength) | |
: base(maximumLength) | |
{ | |
} | |
public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context) | |
{ | |
if (MinimumLength > 0) | |
{ | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue("MinMaxLengthError"); | |
} | |
else | |
{ | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue("MaxLengthError"); | |
} | |
yield return | |
new ModelClientValidationStringLengthRule(FormatErrorMessage(metadata.GetDisplayName()), MinimumLength, MaximumLength); | |
} | |
public UmbracoStringLengthAttribute(int maximumLength, string resourceName) | |
: base(maximumLength) | |
{ | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue(resourceName); | |
} | |
} | |
public class DictionaryMinLengthAttributeAttribute : MinLengthAttribute, IClientValidatable | |
{ | |
public DictionaryMinLengthAttributeAttribute(int length) | |
: base(length) | |
{ | |
} | |
public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context) | |
{ | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue("MinLengthError"); | |
yield return | |
new ModelClientValidationMinLengthRule(FormatErrorMessage(metadata.GetDisplayName()), Length); | |
} | |
public DictionaryMinLengthAttributeAttribute(int length, string resourceName) | |
: base(length) | |
{ | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue(resourceName); | |
} | |
} | |
public class DictionaryMaxLengthAttributeAttribute : MaxLengthAttribute, IClientValidatable | |
{ | |
public DictionaryMaxLengthAttributeAttribute(int length) | |
: base(length) | |
{ | |
} | |
public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context) | |
{ | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue("MaxLengthError"); | |
yield return | |
new ModelClientValidationMaxLengthRule(FormatErrorMessage(metadata.GetDisplayName()), Length); | |
} | |
public DictionaryMaxLengthAttributeAttribute(int length, string resourceName) | |
: base(length) | |
{ | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue(resourceName); | |
} | |
} | |
public class DictionaryRegularExpressionAttribute : RegularExpressionAttribute, IClientValidatable | |
{ | |
public string ResourceName { get; set; } = "RegexError"; | |
public DictionaryRegularExpressionAttribute(string pattern) | |
: base(pattern) | |
{ | |
} | |
public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context) | |
{ | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue(ResourceName); | |
yield return new ModelClientValidationRegexRule(FormatErrorMessage(metadata.GetDisplayName()), Pattern); | |
} | |
} | |
public class DictionaryCompareAttribute : System.ComponentModel.DataAnnotations.CompareAttribute, IClientValidatable | |
{ | |
public new string OtherPropertyDisplayName { get; internal set; } | |
public DictionaryCompareAttribute(string otherProperty) | |
: base(otherProperty) | |
{ | |
} | |
public override string FormatErrorMessage(string name) | |
{ | |
return string.Format(CultureInfo.CurrentCulture, ErrorMessageString, name, OtherPropertyDisplayName ?? OtherProperty); | |
} | |
public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context) | |
{ | |
if (metadata.ContainerType != null) | |
{ | |
if (OtherPropertyDisplayName == null) | |
{ | |
OtherPropertyDisplayName = ModelMetadataProviders.Current.GetMetadataForProperty(() => metadata.Model, metadata.ContainerType, OtherProperty).GetDisplayName(); | |
} | |
} | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue("CompareError"); | |
yield return new ModelClientValidationEqualToRule(FormatErrorMessage(metadata.GetDisplayName()), OtherProperty); | |
} | |
} | |
public class DictionaryEmailAddress : RegularExpressionAttribute, IClientValidatable | |
{ | |
public string ResourceName { get; set; } = "EmailError"; | |
private static new string Pattern { get; set; } = @"^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$"; | |
public DictionaryEmailAddress() | |
: base(Pattern) | |
{ | |
} | |
public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context) | |
{ | |
ErrorMessage = UmbracoDictionary.GetDictionaryValue(ResourceName); | |
yield return new ModelClientValidationRegexRule(FormatErrorMessage(metadata.GetDisplayName()), Pattern); | |
} | |
} | |
public class UmbracoDictionary | |
{ | |
private static UmbracoHelper _helper; | |
private static UmbracoHelper Helper | |
{ | |
get | |
{ | |
if (_helper == null) | |
{ | |
_helper = new UmbracoHelper(); | |
} | |
return _helper; | |
} | |
} | |
public static string GetDictionaryValue(string resourceKey) | |
{ | |
string key = Helper.GetDictionaryValue(resourceKey); | |
if (!string.IsNullOrEmpty(key)) | |
return key; | |
return resourceKey; // Fallback with the key name | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment