Per Magne Skuseth
Mar 10, 2014
  13163
(4 votes)

Attribute-based default values

Default property values on content in EPiServer are set by overriding SetDefaultValues. In an attempt to make my model classes a bit tidier, by not having to do the override in lots of places, I wrote a little piece of code which enables the use of the DefaultValue attribute (found in System.Component), like so:

[DefaultValue("It's all in the hips")]
public virtual string Tip { get; set; }

 

Below is the code that is needed in order to make this work. In this particular case, SitePageData is the base class for all my page types.

public abstract class SitePageData : PageData
{
    public override void SetDefaultValues(ContentType contentType)
    {
        PropertyInfo[] properties = GetType().BaseType.GetProperties();
        foreach (var property in properties)
        {
            var defaultValueAttribute = property.GetAttribute<DefaultValueAttribute>();
            if (defaultValueAttribute != null)
            {
                this[property.Name] = defaultValueAttribute.Value;
            }
        }
        base.SetDefaultValues(contentType);
    }
}

 

Now, as long as my page types inherits SitePageData, the attribute can be utilized. Example:

[ContentType(DisplayName = "Article", GUID = "ED1B0CD5-1307-49FA-853F-ADF46CCEE1CE")]
public class ArticlePage : SitePageData
{
    [DefaultValue(true)]
    public virtual bool HideSomething { get; set; }
 
    [DefaultValue(10)]
    public virtual int MaxNewsItems { get; set; }
 
    [DefaultValue("Bla bla bla")]
    public virtual XhtmlString MainBody { get; set; }
}
Mar 10, 2014

Comments

Mar 10, 2014 10:08 AM

Nice!

Vincent
Vincent Mar 10, 2014 11:12 AM

IMO, I prefer to set these values in one place as you override the SetDefaultValues function, it applies to the new page instance only once. If you make them as attribute, it will mislead the other developers as they may try to use this to alter the property's value.

Mar 10, 2014 11:47 AM

Simple and good idea! Thanx!

valdis
valdis Mar 10, 2014 01:58 PM

Nice!

Gayathri Saravanan
Gayathri Saravanan Mar 13, 2014 05:01 PM

Nice...

Per Magne Skuseth
Per Magne Skuseth May 12, 2014 04:29 PM

Thanks! However, Code Monkey does have a really good point, which should be seriously considered before thinking about implementing something like this.

Henrik Fransas
Henrik Fransas Jun 22, 2015 02:53 PM

Have not seen this before, Great work as always Per Magne!

Shoma Gujjar
Shoma Gujjar Jul 29, 2015 02:07 PM

Hi,

Thanks for the great post. It works well however, if i make my property [Required] , it does not apply the default attribute. Is this an issue?

nitin anand
nitin anand Jan 23, 2019 12:20 PM

Any way to set default values to new properties on existing pages?

Please login to comment.
Latest blogs
Creating an Optimizely CMS Addon - Adding an Editor Interface Gadget

In   Part One   of this series, I covered getting started with creating your own AddOn for Optimizely CMS 12. This covered what I consider to be an...

Mark Stott | Aug 30, 2024

Configure your own Search & Navigation timeouts

The main blog Configure your own Search & Navigation timeouts was posted for years but you need copy the code to your application. We now bring tho...

Manh Nguyen | Aug 30, 2024

Joining the Optimizely MVP Program

Andy Blyth has been honoured as an Optimizely MVP, recognising his contributions to the Optimizely community. Learn how this achievement will enhan...

Andy Blyth | Aug 29, 2024 | Syndicated blog

Welcome 2024 Summer OMVPs

Hello, Optimizely community! We are thrilled to announce and welcome the newest members to the Optimizely Most Valuable Professionals (OMVP) progra...

Patrick Lam | Aug 29, 2024

Create custom folder type in Edit Mode

Content Folders, which are located in assets pane gadget or multichannel content gadget, allow you to add any type of block or folders. But...

Grzegorz Wiecheć | Aug 28, 2024 | Syndicated blog

Creating an Optimizely AddOn - Getting Started

When Optimizely CMS 12 was launched in the summer of 2021, I created my first AddOn for Optimizely CMS and talked about some of the lessons I learn...

Mark Stott | Aug 28, 2024