Ravindra S. Rathore
Jul 22, 2019
  1555
(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
Display Child Pages in Content Delivery API Response

The below example will implement an instance of IContentConverterProvider to customise the serialisation of PageData and output child pages in the...

Minesh Shah (Netcel) | Oct 4, 2022

Bring the Report Center back in Optimizely CMS 12

The Report Center has been a part of Optimizely CMS since its first debut in version 5R2 in 2008, but in CMS 12, it's removed! Don't despair! Make...

Tomas Hensrud Gulla | Oct 4, 2022 | Syndicated blog

Customizing Property Lists in Optimizely CMS

Generic property lists is a cool editorial feature that has gained a lot of popularity - in spite of still being unsupported (officially). But if y...

Allan Thraen | Oct 2, 2022 | Syndicated blog

Optimizely names Luminary Senior Developer, Ynze Nunnink, OMVP

Luminary Senior Developer and Optimizely Lead, Ynze Nunnink has secured the coveted position of Optimizely MVP. Earning a Platinum badge for his...

Ynze | Oct 2, 2022 | Syndicated blog

Content Delivery API – The Case of the Duplicate API Refresh Token

Creating a custom refresh provider to resolve the issues with duplicate tokens in the DXC The post Content Delivery API – The Case of the Duplicate...

David Lewis | Sep 29, 2022 | Syndicated blog

A multi-brand strategy in Optimizely DXP

The Optimizely Digital Experience Platform (DXP) is ideally suited to digital projects featuring multiple websites or applications. Here, we showca...

Ynze | Sep 29, 2022 | Syndicated blog