Validating a List<T> To ensure list contains at list one Item with Data Annotations MVC C#

Question

I'm trying to validate a generic list e.g List<Sales> so that the list should contain at least one item added via check boxes.

Here is how I've tried to work this:

  public class SalesViewModel :IValidatableObject
    {

        [Required]
        public List<Sales> AllSales{ get; set; }


        public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
        {
            if (AllSales.Length == 0)
                yield return new ValidationResult("Please pick one sales item");
        }
    }

Just want to know if this is the right approach to this kind of scenario.

Your approach is feasible, the following post answer is also optional. — LouraQ
– LouraQ, Commented Apr 29, 2020 at 6:55

Jeremy Caney · Accepted Answer · 2020-04-28 20:41:55Z

7

You can also create a custom validation attribute, similar to the following:

public class EnsureOneItemAttribute : ValidationAttribute
{
  public override bool IsValid(object value)
  {
    var list = value as IList;
    if (list != null)
    {
       return list.Count > 0;
    }
    return false;
  }     
}

And then apply it like:

[EnsureOneItemAttribute (ErrorMessage = "Please pick one sales item")]
public List<Sales> AllSales{ get; set; }

edited Apr 28, 2020 at 20:41

Jeremy Caney

7,808115 gold badges57 silver badges86 bronze badges

answered Apr 28, 2020 at 12:49

Zeeshan

4962 gold badges5 silver badges21 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Hendrik Clercx Over a year ago

If you're using C# 7.0+ you can make use of pattern matching. Syntax would be: return value is IList list && list.Count > 0;

stefan.seeland · Accepted Answer · 2023-08-30 12:26:58Z

6

Simplest version:

public class SalesViewModel
{

    [Required, MinLength(1, ErrorMessage = "Please pick one sales item")]
    public List<Sales> AllSales{ get; set; }
}

answered Aug 30, 2023 at 12:26

stefan.seeland

3,3912 gold badges28 silver badges39 bronze badges

1 Comment

Don Rolling Over a year ago

Love this, didn't know it existed. Why create your own validation attribute if you don't need to? +1

IeuanW · Accepted Answer · 2021-08-11 15:40:15Z

I know im a bit late, but this attribute allows you to set the min and max items

[AttributeUsage(AttributeTargets.All, AllowMultiple = false)]
public class EnsureMinimumElementsAttribute : ValidationAttribute
{
    private readonly int _min;
    private readonly int _max;

    public EnsureMinimumElementsAttribute(int min = 0, int max = int.MaxValue)
    {
        _min = min;
        _max = max;
    }

    public override bool IsValid(object value)
    {
        if (!(value is IList list))
            return false;

        return list.Count >= _min && list.Count <= _max;
    }
}

Usage -

Minumum, no max

[EnsureMinimumElements(min: 1, ErrorMessage = "Select at least one item")]

Min and Max

[EnsureMinimumElements(min: 1, max: 6, ErrorMessage = "You can only add 1 to 6 items to your basket")]

No min

[EnsureMinimumElements(max: 6, ErrorMessage = "You can add upto 6 items to your basket")]

Collectives™ on Stack Overflow

Validating a List<T> To ensure list contains at list one Item with Data Annotations MVC C#

3 Answers 3

1 Comment

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related