SaaS CMS has officially launched! Learn more now.

Ram Kumar K
Oct 7, 2018
  5890
(0 votes)

Required Field Validation for Category

We all have come across specific requirements for CMS Content authors. One of such requirement for our news sections is, "Every news article belongs to one or more categories". We must force user to select a category before publish it. We have used a Custom validation rule to fulfill this requirement.

Episerver Documentation: https://world.episerver.com/documentation/developer-guides/CMS/Content/Properties/built-in-property-types/Writing-custom-attributes/

  /// <summary>
     /// Required field validation for Category.
    ///Reference: https://world.episerver.com/documentation/developer-guides/CMS/Content/Properties/built-in-property-types/Writing-custom-attributes/
    /// </summary>

  [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
    public class FieldRequiredForPublishAttribute : ValidationAttribute
    {
        public bool IsRequired { get; set; }
        public FieldRequiredForPublishAttribute() : this(true) { }
        public FieldRequiredForPublishAttribute(bool isRequired)
        {
            IsRequired = isRequired;
        }

        public override bool IsValid(object value)
        {
            if (value == null) return false;        
            if (value is CategoryList cat) return cat?.Any() == true;          
            return false;
        }

        public override string FormatErrorMessage(string name)
        {
                return $"{name} cannot be empty";
        }
    }

Set RequiredFieldAttribute for News Pages.

        [Display(
              Name = "News Category (*)",
              Description = "Select News Category",
              GroupName = SystemTabNames.Content,
              Order = 3)]
          [FieldRequiredForPublish]
        public override CategoryList Category { get; set; }

 The code is generic enough that you can extend to make any field requied.

Thank you  & happy coding!

Oct 07, 2018

Comments

Stephan Lonntorp
Stephan Lonntorp Oct 8, 2018 07:20 PM

Why not use the built in RequiredAttribute from System.DataAnnotations?

Ram Kumar K
Ram Kumar K Oct 9, 2018 11:43 AM

When you are using "Required" built in functionality, you must enter "required" fields first in the content page. That would chnage the content fields order and may cause confusion. This validation occurs post content creation and before publishing the content. It would let authors save the content and won't publish until validation.

Antti Alasvuo
Antti Alasvuo Oct 9, 2018 06:22 PM

Just in case someone wants to use the RequiredAttribute but not show the fields when creating content then have also a look at Davids blog posting about hiding required properties when creating content. This approach needs less code to achieve the requirement: "don't show property on create content view but have the field required" BUT targeting only CategoryList type currently, so would need some additional code to cover various types.

Please login to comment.
Latest blogs
Optimizely release SaaS CMS

Discover the future of content management with Optimizely SaaS CMS. Enjoy seamless updates, reduced costs, and enhanced flexibility for developers...

Andy Blyth | Jul 17, 2024 | Syndicated blog

A day in the life of an Optimizely Developer - London Meetup 2024

Hello and welcome to another instalment of A Day In The Life Of An Optimizely Developer. Last night (11th July 2024) I was excited to have attended...

Graham Carr | Jul 16, 2024

Creating Custom Actors for Optimizely Forms

Optimizely Forms is a powerful tool for creating web forms for various purposes such as registrations, job applications, surveys, etc. By default,...

Nahid | Jul 16, 2024

Optimizely SaaS CMS Concepts and Terminologies

Whether you're a new user of Optimizely CMS or a veteran who have been through the evolution of it, the SaaS CMS is bringing some new concepts and...

Patrick Lam | Jul 15, 2024