Aniket
Oct 7, 2018
  5058
(3 votes)

Max & Min element validation for Content Area or Link Collection

Reccently we had a business requirement for setting minimum & maximum limit for blocks in Content Areas. While we can educate the content authors to set the correct number of blocks in the content area it's always recommended to add validation within the CMS to avoid human errors.

Here's the code to to set the maximum number of blocks in the content area and Link Item Collection. 

/// <summary>
    /// Sets the maximum element count in a linkcollection, a content area - or any other type of collection.
    /// </summary>
    [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
    public class MaxElementsAttribute : ValidationAttribute, IMetadataAware
    {
        public int MaxCount { get; set; }

        public void OnMetadataCreated(ModelMetadata metadata)
        {
            //TODO: Use to disable editor drag and drop at a certain point.
        }

        protected override ValidationResult IsValid(object value, ValidationContext validationContext)
        {
            if (value == null)
            {
                return null;
            }
            if (value is LinkItemCollection)
            {
                if ((value as LinkItemCollection).Count > MaxCount)
                {
                    return new ValidationResult("This field exceeds the maximum limit of " + MaxCount + " items");
                }
            }
            else if (value is ContentArea)
            {
                if ((value as ContentArea).Count > MaxCount)
                {
                    return new ValidationResult("This field exceeds the maximum limit of " + MaxCount + " items");
                }
            }

            return null;
        }

        public MaxElementsAttribute(int MaxElementsInList)
        {
            this.MaxCount = MaxElementsInList;
        }
    }

On the Content Area field (or Link Item Collection) set the MaxElements attribute as shown below. 

[Display(
            Name = "Items",
            Description = "Items",
            GroupName = SystemTabNames.Content,
            Order = 30)]
        [MaxElements(25)]
        public virtual ContentArea Items { get; set; }

You can use the same logic for setting the minimum number of elements as well. 



Happy coding :)

Oct 07, 2018

Comments

Antti Alasvuo
Antti Alasvuo Oct 9, 2018 05:49 AM

Hi Aniket, first thanks for sharing this.

You should use the 'is' pattern matching in the code, see the docs. Now you first test is the value of some type (casting) and then if it was successful then the code casts again the object.

The XML comment says that it handles 'any other type of collection' but there is no implementation for collections in the code you have provided.

Please login to comment.
Latest blogs
You Just Got Vectored! SVG Image Formats

 If you're reading this, then you've come across a need that nearly all Opti developers encounter in their careers; You need to display a vector...

Greg J | Feb 3, 2023 | Syndicated blog

CMS Core 12.12.0 delisted from Nuget feed

We have decided to delist version 12.12.0 of the CMS Core packages from our Nuget feed. As a consequence, we are also temporarily delisting version...

Magnus Rahl | Feb 3, 2023

How Optimizely Web Experimentation enables fast validation of design and UX changes

Ever wondered how to increase conversion rates and quickly validate design/UX alternatives to find the most impactful changes? I wrote a practical...

Jacob Pretorius | Jan 31, 2023

What’s next after Google Optimize’s sunsetting?

Google has announced that it is sunsetting the Google Optimize and Optimize 360 services, forcing customers to explore new platforms and invest in...

Ynze | Jan 31, 2023 | Syndicated blog