Skip to content

Latest commit

 

History

History
103 lines (87 loc) · 5.18 KB

EditorModel-Events.md

File metadata and controls

103 lines (87 loc) · 5.18 KB
Raw

EditorModel Events

The EditorModelEventManager class is used to emit events that enable you to manipulate the model used by the backoffice before it is loaded into an editor (for example the SendingContentModel event fires just before a content item is loaded into the backoffice for editing). It is therefore the perfect event to use to set a default value for a particular property, or perhaps to hide a property/tab from a certain editor.

Usage

Example usage of the EditorModelEventManager 'SendingContentModel' event - eg set the default PublishDate for a new NewsArticle to be today's date:

using Umbraco.Core;
using Umbraco.Core.Events;
using Umbraco.Core.Models;
using Umbraco.Web.Editors;
using Umbraco.Web.Models.ContentEditing;

namespace My.Namespace
{
    public class MyEventHandler : ApplicationEventHandler
    {
        protected override void ApplicationStarted(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
        {
            EditorModelEventManager.SendingContentModel += EditorModelEventManager_SendingContentModel;   
        }            

        private void EditorModelEventManager_SendingContentModel(System.Web.Http.Filters.HttpActionExecutedContext sender, EditorModelEventArgs<Umbraco.Web.Models.ContentEditing.ContentItemDisplay> e)
        {            
            //set a default value for NewsArticle PublishDate property, the editor can override this, but we will suggest it should be todays date
            if (e.Model.ContentTypeAlias == "newsArticle")
            {
                var pubDateProperty = e.Model.Properties.FirstOrDefault(f => f.Alias == "publishDate");
                if (pubDateProperty.Value == null || String.IsNullOrEmpty(pubDateProperty.Value.ToString()))
                {
                    //set default value if the date property is null or empty
                    pubDateProperty.Value = DateTime.UtcNow;
                }
            }
        }
    }
}

Events

Event Signature Description
SendingContentModel (HttpActionExecutedContext sender, EditorModelEventArgs<ContentItemDisplay> e) Raised just before the editor model is sent for editing in the content section
NOTE: 'e' contains a model property of *Umbraco.Web.Models.ContentEditing.ContentItemDisplay* type which in turn contains the tabs and properties of the elements about to be loaded for editing
SendingMediaModel (HttpActionExecutedContext sender, EditorModelEventArgs<MediaItemDisplay> e) Raised just before the editor model is sent for editing in the media section
NOTE: 'e' contains a model property of *Umbraco.Web.Models.ContentEditing.MediaItemDisplay* type which in turn contains the tabs and properties of the elements about to be loaded for editing
SendingMemberModel (HttpActionExecutedContext sender, EditorModelEventArgs<MemberDisplay> e) Raised just before the editor model is sent for editing in the member section.
NOTE: 'e' contains a model property of *Umbraco.Web.Models.ContentEditing.MemberDisplay* type which in turn contains the tabs and properties of the elements about to be loaded for editing

EditorModelEventArgs

The EditorModelEventArgs class has two properties, one 'Model' representing the type of Model being sent, eg 'ContentItemDisplay' and an 'UmbracoContext' property representing the current context.

ContentItemDisplay

A model representing a content item to be displayed in the backoffice

  • TemplateAlias
  • Urls
  • AllowPreview - Determines whether previewing is allowed for this node, By default this is true but by using events developers can toggle this off for certain documents if there is nothing to preview
  • AllowedActions - The allowed 'actions' based on the user's permissions - Create, Update, Publish, Send to publish
  • IsBlueprint
  • Tabs - Defines the tabs containing display properties
  • Properties - properties based on the properties in the tabs collection

MediaItemDisplay

A model representing a media item to be displayed in the backoffice

  • Tabs - Defines the tabs containing display properties
  • Properties - properties based on the properties in the tabs collection

MemberDisplay

A model representing a member to be displayed in the backoffice

  • Username
  • Email
  • MembershipScenario
  • MemberProviderFieldMapping - This is used to indicate how to map the membership provider properties to the save model, this mapping will change if a developer has opted to have custom member property aliases specified in their membership provider config, or if we are editing a member that is not an Umbraco member (custom provider)
  • Tabs - Defines the tabs containing display properties
  • Properties - properties based on the properties in the tabs collection