Try our conversational search powered by Generative AI!

Ravindra S. Rathore
Jul 22, 2019
  2358
(12 votes)

Disallow duplicate items in the Episerver ContentArea Property

Hey guys,

In the past, I learned about the validation attributes and to try it out I have created a validation attribute for disabling the duplicate items(page/block/media) in the ContentArea property. Yesterday some of my colleagues asked me about this so thought to write this post.

So, first of all, I have created a class called “DisallowDuplicatesAttribute” and written the below code

using EPiServer.Core;
using EPiServer.DataAbstraction;
using EPiServer.Framework.Localization;
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Web;

namespace Test.Infrastructure.Cms.Models.Attributes
{
    [AttributeUsage(AttributeTargets.Property)]
    public sealed class DisallowDuplicatesAttribute : ValidationAttribute
    {
        protected override ValidationResult IsValid(object value, ValidationContext validationContext)
        {
            var propertyDefinitionRepository = EPiServer.ServiceLocation.ServiceLocator.Current.GetInstance<IPropertyDefinitionRepository>();
            var propertyDefinitionId = ((PageData)validationContext.ObjectInstance).Property[validationContext.MemberName].PropertyDefinitionID;
            var propertyDefinition = propertyDefinitionRepository.Load(propertyDefinitionId);
            propertyDefinition.LocalizationService = LocalizationService.Current;

            if (HasDuplicateItems(value as ContentArea))
            {
                return new ValidationResult(string.Format("Duplicate items are not allowed in {0} Property",
                    new object[] {validationContext.MemberName}));
            }

            return ValidationResult.Success;
        }

        bool HasDuplicateItems(ContentArea contentArea)
        {
            if (contentArea == null || contentArea.IsEmpty)
                return false;
            var contentAreaItems = contentArea.Items;
            if (contentAreaItems == null || !contentAreaItems.Any())
                return false;

            List<int> items = new List<int>();

            foreach (var contentAreaItem in contentAreaItems)
            {
                if (items.Contains(contentAreaItem.ContentLink.ID))
                    return true;

                items.Add(contentAreaItem.ContentLink.ID);
            }

            return false;
        }
    }
}

Now created a new PageType called “TestPage” and applied the newly created attribute on the PageContent contentArea property.

[ContentType(DisplayName = "Test Page", GUID = "133523e4-4da1-49e9-a49d-94a9c9b1d413", Description = "Test Page")]
    public class TestPage: BaseFeedPage
    {
        [DisallowDuplicates]
        [CultureSpecific]
        [Display(
            Name = "PageContent",
            Description = "The page content will be used to show page content",
            GroupName = ApplicationConstants.PropertyGroupNames.Content,
            Order = 100)]
        public virtual ContentArea PageContent { get; set; }
    }

Now if you login into Episerver and then try to drag and drop the same item twice then it will not allow you to publish the page as well as it will give you an error and allow you to publish the page.

Thanks.

Ravindra

Jul 22, 2019

Comments

Praful Jangid
Praful Jangid Jul 22, 2019 01:33 PM

Hi Ravindra,

It's a very nice post. Thanks for that. I have question or you can say kind of suggesion. In your function HasDuplicateItems(), what is the use of adding items into list items? Where are you using those?

Ravindra S. Rathore
Ravindra S. Rathore Jul 23, 2019 07:42 AM

Hey Praful,

I am using that list to comparing it with other items in the ContentArea.

items.Contains(contentAreaItem.ContentLink.ID

Thanks

Ravindra

Praful Jangid
Praful Jangid Jul 23, 2019 08:23 AM

Make sense, thanks.

Or, You can simply replace the whole HasDuplicateItems() function with following code lines

private bool IsDuplicate(ContentArea area)
{
    return area?.Items.DistinctBy(c => c.ContentLink.ToReferenceWithoutVersion()).Count() != area?.Items.Count;
}

Thanks and regards,

~ Praful Jangid

Ravindra S. Rathore
Ravindra S. Rathore Jul 23, 2019 09:44 AM

Yes, We can. It's just a matter of code refactoring.

Please login to comment.
Latest blogs
Build a headless blog with Astro and Optimizely SaaS CMS

I’m a big fan of using the right tool for the right job. I’m also a big fan of Astro , for the right use case. Let's explore Astro to see what it's...

Jacob Pretorius | May 28, 2024

Microsoft announces Natural language to SQL

Finally, Microsoft launches "Natural language to SQL," after it has been available for several months in Optimizely CMS!

Tomas Hensrud Gulla | May 23, 2024 | Syndicated blog

Five easy ways to start personalizing your content right now

If you clicked on this article, you already know that getting the right message to the right person at the right time helps drive conversions and...

Kara Andersen | May 23, 2024

ExtendedCms.TinyMceEnhancements – serwer side webp support

Today I will introduce another small feature of TinyMceEnhancements plugin. The functionality is used to automatically detect whether a browser...

Grzegorz Wiecheć | May 22, 2024 | Syndicated blog