Validation in the WinRT XAML Validation library is mainly based on .NET Data Annotations from the System.ComponentModel.DataAnnotations
namespace. Here you can find several attributes, that you can attach to your entities and its properties. This annotates them with additional information/metadata, which’s evaluated elsewhere in your code or by the .NET framework.
WPF, Silverlight and e.g. ASP.NET MVC can evaluate those attributes automatically to display further information for an entity like a property label, etc.. And you can define validation logic with Data Annotations on your entity, which gets evaluated and presented to the user when the entity is validated.
ValidationAttribute
The WinRT XAML Validation library uses the Data Annotations approach as well to define validation logic on model entities. First you can use the already defined validation attributes from the System.ComponentModel.DataAnnotations
namespace: RangeAttribute
, RegularExpressionAttribute
, RequiredAttribute
, StringLengthAttribute
, CustomValidationAttribute
. All of those predefined attributes implement the ValidationAttribute
base class. You can derive from this class as well to implement validation attributes with your encapsulated custom validation logic, for example:
[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)] public sealed class ValidateGreaterCurrentBidAttribute : ValidationAttribute { protected override ValidationResult IsValid(object value, ValidationContext validationContext) { var newBid = (double?)value; var auctionBid = (AuctionBid)validationContext.ObjectInstance; return newBid.HasValue && newBid.Value <= auctionBid.CurrentBid ? new ValidationResult("Value must be greater than current bid") : ValidationResult.Success; } }
Now you can easily decorate your model entities with this attribute:
public class AuctionBid : ValidationBindableBase { private double currentBid; private double newBid; private double? maxNewBid; public double CurrentBid { get { return this.currentBid; } set { this.SetProperty(ref this.currentBid, value); } } [Range(0, double.MaxValue, ErrorMessage = "Value must not be negative")] [ValidateGreaterCurrentBid] public double NewBid { get { return this.newBid; } set { this.SetProperty(ref this.newBid, value); } } [ValidateGreaterCurrentBid] public double? MaxNewBid { get { return this.maxNewBid; } set { this.SetProperty(ref this.maxNewBid, value); } } }
ExtendedValidationAttribute
With the abstract ExtendedValidationAttribute
class there’s another base validation attribute in the WinRT XAML Validation library that extends the functionality of the ValidationAttribute
. Specifically with this base class you can:
- define a level for the validation message (
Warning
orError
) - define if the validation message should be shown on the property and in the validation summary on the UI
- define if the validation attribute should be considered in implicit validation (when a property changes)
For example, a validation level „Warning
“ leads to the following output on the UI:
The definition on the entity property (taking a custom validation attribute ValidatePossibleMisentryBid as example) looks as follows:
[ValidatePossibleMisentryBid(ValidationLevel = ValidationLevel.Warning)] public double NewBid { ... }
Like the ValidationAttribute
you can use the ExtendedValidationAttribute
as base class for your custom validation attributes.
2 Gedanken zu „WinRT XAML Validation library: Basic Validation Attributes“