Attributes

Table of Contents

• ContentType attribute
• Access attributes
• AvailablePageTypes attributes
• TemplateDescriptor attribute
• Property attributes
• Image URL attribute
• Default backing types

ContentType

The required attribute for block and page types is called ContentType, and is located in the EPiServer.DataAnnotations namespace. The configurable properties for the attribute are displayed below.

Access

The access attribute defines which users, roles, and visitor groups that will have access rights to create a page or block based on the content type.

The following image shows how the attribute properties are mapped to settings in admin mode.

AvailablePageTypes

There is an additional optional attribute for page types called AvailablePageTypes that can be used to set which page types that should be available under a page instance. The configurable properties for the attribute are displayed below.

The types given on Include, Exclude, IncludeOn and ExcludeOn can either be a typed page (that is a type inheriting PageData) directly or it can be the type of an interface or a baseclass. At registration all registered types that can be assigned to the specified type will be included. For example, if an interface is specified in Include list then all typed pages that implement the interface will be included.

IncludeOn differs from Include in the way that it is not excluding. That is for types in IncludeOn that has all page types available no page types will be excluded. Include on the other hand will exclude all typed pages except the ones given in Include. Below is an image that shows how Include and IncludeOn are mapped to settings in admin mode.

Exclude works so that if no types are set on Include then the result will be that all registered page types except the Exclude ones are available. If there are types registered in Include then all types in Include except the ones in Exclude are available. Below is an image that shows how Exclude and ExcludeOn are mapped to settings in admin mode.

Below is an image that shows how Availability is mapped to settings in admin mode.

TemplateDescriptor

The [TemplateDescriptor] attribute can be used on templates to add meta data to the template. The attribute can also be used to set the template as the default template for the page data. The attribute, which exists in the EPiServer.Framework.DataAnnotations namespace, contains the following properties:

Property attributes

For properties of content types we use different attributes to describe how they should behave. The following are located in the EPiServer.DataAnnotations namespace.

The following are located in the System.ComponentModel.DataAnnotations namespace.

ImageUrl

The attribute called ImageUrl can be used to set the icon for both blocks and pages.

Default Backing Types

If the BackingType attribute has not been set for a property, the backing type will be automatically assigned to a PropertyDefinitionType where the corresponding EPiServer.Core.PropertyData.PropertyValueType matches the property type. That means that if there is a PropertyData implementation (can be a custom property) with matching PropertyValueType that defintion will be used. Otherwise the backing type is assigned according to this table.

The following images show how the attributes are mapped to settings in Admin mode.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using EPiServer.Core;
using EPiServer.DataAnnotations;
using System.ComponentModel.DataAnnotations;
using EPiServer.Security;
using EPiServer;
using EPiServer.Web;
using EPiServer.Shell.ObjectEditing.EditorDescriptors;
using EPiServer.Shell.ObjectEditing;

namespace CodeSamples
{
    [ContentType(
        DisplayName="My Page Type",
        Description="Description for this page type",
        Order=1024,
        GUID="9CBBF910-CB5A-4C72-83AA-EDCF02E8A2BD",
        GroupName="My Group",
        AvailableInEditMode=true)]
    [AvailablePageTypes(Include = new Type[] { typeof(MyPageType2), typeof(MyPageType3) })]
    [Access(Users = "niis", Roles = "CmsEditors")]
    public class TypedPageWithAttributeSample : PageData
    {
        [Required]
        [Searchable]
        [CultureSpecific]
        [Editable(true)]
        [Display(
            Name = "My Heading",
            Description = "Heading for my page type.",
            GroupName = "My Tab",
            Order = 64)]
        public virtual string Heading { get; set; }

        //An integer between 0 and 130.
        [Range(0, 130)]
        public virtual int Age { get; set; }

        //A string containing a valid email address.
        [RegularExpression(EPiServer.Framework.Validator.DefaultEmailRegexString)]
        public virtual string Email { get; set; }

        //A string with a maximum length of 20 characters.
        [StringLength(20)]
        public virtual string Header { get; set; }

        //Any URL
        public virtual Url RedirectPage { get; set; }

        //URL to image.
        [UIHint(UIHint.Image)]
        public virtual Url Logotype { get; set; }

        //Creates a selection of predefined values.
        [UIHint("languageselection")]
        public virtual string Language { get; set; }
    }

    [EditorDescriptorRegistration(UIHint = "languageselection")]
    public class CustomLanguageEditorDescriptor : EditorDescriptor
    {
        public CustomLanguageEditorDescriptor()
        {
            //Define an episerver selection editor that can be bound to the values generated
            //from a class implementing ISelectionFactory.
            ClientEditingClass = "epi.cms.contentediting.editors.SelectionEditor";
            SelectionFactoryType = typeof(CustomLanguageSelectionFactory);
        }
    }

    public class CustomLanguageSelectionFactory : ISelectionFactory
    {
        public IEnumerable<ISelectItem> GetSelections(ExtendedMetadata metadata)
        {
            var languages = new List<SelectItem>();

            languages.Add(new SelectItem() { Text = "English", Value = "en"});
            languages.Add(new SelectItem() { Text = "Swedish", Value = "sv" });
            languages.Add(new SelectItem() { Text = "Norwegian", Value = "no" });

            return languages;
        }
    }

    [AvailablePageTypes(IncludeOn = new Type[] { typeof(TypedPageWithAttributeSample) })]
    [ContentType]
    public class MyPageType1 : PageData { }

    [AvailablePageTypes(Exclude = new Type[] { typeof(TypedPageWithAttributeSample) })]
    [ContentType]
    public class MyPageType2 : PageData { }

    [AvailablePageTypes(ExcludeOn = new Type[] { typeof(MyPageType1) })]
    [ContentType]
    public class MyPageType3 : PageData { }

    [AvailablePageTypes(Availability = EPiServer.DataAbstraction.PageTypeAvailability.Availability.None)]
    [ContentType]
    public class MyPageType4 : PageData { }
}