Hide menu Last updated: Sep 21 2015

Restricting content types in properties

This document describes how to control the addition of certain items to a property of type ContentArea, ContentReference or ContentReferenceList.

Restricting a ContentArea

The AllowedTypes attribute (placed in the EPiServer.DataAnnotations namespace, EPiServer assembly) can be applied to a property.

[AllowedTypes(new [] { typeof(PageData) })]
public virtual ContentArea RelatedContentArea { get; set; }

The same attribute can also be set as: 

[AllowedTypes(AllowedTypes = new [] { typeof(PageData) })]
public virtual ContentArea RelatedContentArea { get; set; }

When an item that is part of the allowed types is dragged over this property, the property is highlighted, and the editor can add the item to the property. But if editor tries to drag another item which is not part of allowed types, the property is grayed out, and the item can't be added. The content selector dialog is also filtered out accordingly. Through the Create a new block link in the content area, editors can only add allowed item types.

You can specify several allowed types as well as inherited types:

[AllowedTypes(new [] {typeof(PageData), typeof(BlockData)})]
public virtual ContentArea RelatedContentArea { get; set; }

Restricting a certain set of types but allowing all others

The AllowedTypes attribute can also be used to restrict a certain set of types from a larger pool of types. 
For example, if you supply two arrays of types as constructor arguments, the first array argument considers allowed items, while the second argument considers restricted items. 

[AllowedTypes(new [] { typeof(BlockData) }, new [] { typeof(EditorialBlock) })]
public virtual ContentArea RelatedContentArea { get; set; }

or 

[AllowedTypes(AllowedTypes = new [] { typeof(BlockData) }, RestrictedTypes = new [] { typeof(EditorialBlock) })]
public virtual ContentArea RelatedContentArea { get; set; }

In this case, all BlockData items can be added to the content area except the EditorialBlock, which is a BlockData but also part of restricted types. When an editor drags the EditorialBlock or its sub types, the content area is grayed out. Similarly, when an editor clicks the Create a new block link, the content selector is filtered out accordingly.

Restriction based on base classes and interfaces

Once you place the AllowTypes attribute on a ContentArea, ContentReference or ContentReferenceList property, the user interface not only allows and restricts based on the given type but also on all of the given type's sub types. For example: 

[AllowedTypes(new [] { typeof(SiteBlockData) })]
public virtual ContentArea RelatedContentArea { get; set; }

In this case, the property not only allows the SiteBlockData to be added but all other types inherited from the SiteBlockData also behave the same.

However, if you want to allow and restrict based on an interface, you must implement the UIDescriptor for the interface.

interface ISpecialInterface { } 

public class SpecialBlock : BlockData, ISpecialInterface {}

If you now want to enable a content area to allow all blocks to be added except the ones inherited from the ISpecialInterface, you first have to implement a UIDescriptor for the ISpecialInterface. 

[UIDescriptorRegistration]
public class SpecialInterfaceDescriptor : UIDescriptor<ISpecialInterface> { }

After that, place the AllowedTypes on the content area property.

[AllowedTypes(AllowedTypes = new [] { typeof(BlockData) }, RestrictedTypes = new [] { typeof(ISpecialInterface) })]
public virtual ContentArea SomeArea { get; set; }

This code allows all blocks to be added to SomeArea but restricts blocks that implement ISpecialInterface.

Restricting content reference properties

The AllowedTypes attribute can be used for ContentReference or ContentReferenceList properties as well:

[AllowedTypes( typeof(ProductPage))]
public virtual ContentReference SomeLink { get; set; }
[AllowedTypes( typeof(ProductPage))]
public virtual IList<ContentReference> SomeLinks { get; set; }

This code results in the same behavior as for content areas when dragging items to the property; that is, only items of the type ProductPage can be added to the property. Items not allowed (according to the AllowedTypes attribute) are not selectable in the content selector dialog.

Known limitations

 

  • AllowedTypes only works with ContentArea, ContentReference and ContentReferenceList type properties.
  • RestrictedTypes always win. That means that if an item (a class or an interface) is given in RestrictedTypes, all of its instances and sub items are restricted whether or not the item or sub items exist in AllowedTypes. 

Comments