Ram Kumar K
Oct 7, 2018
  4389
(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
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

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

Migrating from Providers to CMS 12 ASP.NET Identity with cookie tweaks

Notes on migrating a multi-site from Membership and Role Providers to ASP.NET Identity and changing cookie options dynamically.

Johan Kronberg | Jan 30, 2023 | Syndicated blog

Integrating generative AI in Optimizely CMS: A quick test with OpenAI

Some of the new AI services have received a lot of attention recently. Can you integrate them in Optimizely CMS? Of course, you can!

Tomas Hensrud Gulla | Jan 30, 2023 | Syndicated blog