Oct 6, 2015
(3 votes)

Limiting Page Type Instances

We had a requirement to limit the number of instances of a particular page type within parts of the page tree. I developed a simple attribute and validator which implements this.

You add the attribute to your page type class and specifiy the scope of the check. The scope options I added were :

  • Site - only x instances of the page type can exist on the site, anywhere in the page tree. Probably useful for singletons
  • Same parent - only x instances of the page type can exist in the same parent node, i.e. amongst siblings
  • Same parent and descendants - only x instances of the page type can exist in the same parent node including descendant nodes

Obviously, you could easily add more scope variants here to suite your requirements. The code can be found below:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using EPiServer;
using EPiServer.Core;
using EPiServer.Validation;

public class AllowedInstancesAttribute : Attribute
    public AllowedInstancesAttribute(int maxInstances)
        MaxInstances = maxInstances;

    public enum InstanceScope

    public int MaxInstances { get; set; }
    public InstanceScope Scope { get; set; }

public class AllowedInstancesValidator : IValidate<PageData>
    private readonly IContentLoader contentLoader;

    public AllowedInstancesValidator(IContentLoader contentLoader)
        this.contentLoader = contentLoader;

    public IEnumerable<ValidationError> Validate(PageData instance)
        var allowedInstanceAttribute = instance.GetType().GetCustomAttribute<AllowedInstancesAttribute>(true);

        if (allowedInstanceAttribute == null)
            return Enumerable.Empty<ValidationError>();

        var searchRoot = allowedInstanceAttribute.Scope == AllowedInstancesAttribute.InstanceScope.Site
                                ? ContentReference.StartPage
                                : instance.ParentLink;

        var instancesOfType = this.GetInstancesOfType(instance.GetType(), searchRoot, allowedInstanceAttribute.Scope);

        if (instance.PendingPublish)

        if (instancesOfType > allowedInstanceAttribute.MaxInstances)
            return new[]
                new ValidationError()
                        ErrorMessage = string.Format("Only {0} instances of this page type can exist at this level", allowedInstanceAttribute.MaxInstances),
                        PropertyName = "PageName",
                        Severity = ValidationErrorSeverity.Error,
                        ValidationType = ValidationErrorType.StorageValidation

        return Enumerable.Empty<ValidationError>();

    private int GetInstancesOfType(Type type, ContentReference rootPage, AllowedInstancesAttribute.InstanceScope instanceScope)
        var instances = 0;
        var children = contentLoader.GetChildren<IContent>(rootPage, new LoaderOptions());

        foreach (var child in children)
            if (type == child.GetType())

            if (instanceScope == AllowedInstancesAttribute.InstanceScope.SameParent)

            instances += this.GetInstancesOfType(type, child.ContentLink, instanceScope);    

        return instances;
Oct 06, 2015


Grzegorz Wiecheć
Grzegorz Wiecheć Oct 6, 2015 08:00 PM

Interesting feature. We implemented something simalar a while ago, but it was not that configurable. Your solution could be useful in many projects.

I could add that validator is not executed when moving content. So if you have "full" tree level and move another page from somewhere else the Validate method will not protect from extending the limit. To solve it we implemented additional validation in MoveContent method of IContentEvents service.

valdis Oct 7, 2015 12:22 PM

Wrap it up as nuget package please :)

Please login to comment.
Latest blogs
Zombie Properties want to Eat Your Brains

It’s a story as old as time. You work hard to build a great site. You have all the right properties – with descriptive names – that the content...

Joe Mayberry | Mar 29, 2023 | Syndicated blog

Optimizely finally releases new and improved list properties!

For years, the Generic PropertyList has been widely used, despite it being unsupported. Today a better option is released!

Tomas Hensrud Gulla | Mar 28, 2023 | Syndicated blog

Official List property support

Introduction Until now users were able to store list properties in three ways: Store simple types (int, string, DateTime, double) as native...

Bartosz Sekula | Mar 28, 2023

New dashboard implemented in CMS UI 12.18.0

As part of the CMS UI 12.18.0 release , a new dashboard has been added as a ‘one stop shop’ to enable editors to access all of their content items,...

Matthew Slim | Mar 28, 2023