This content is archived. See latest version here.

Last updated: Feb 23 2015

Configuring the default editor wrapper

Introduction

From version 7.19, the default editor wrapper is floating. A floating editor will appear next to its respective property and only take as much size as required. The result is that we have an edit experience where you can see more of what is changing on the page as you edit the property. However in some cases the default editor wrapper may need to be change back to the flyout. This document describes how to configure the editor to be flyout.

Configuration

The configuration of the default editor wrapper must take place at initialization time before the UI is displayed so that the correct confiuration data gets sent to the interface. This is easiest done with an InitializableModule.

using EPiServer.Cms.Shell;
using EPiServer.Framework;
using EPiServer.Framework.Initialization;
using EPiServer.Shell;

namespace MyProject.Business.Initialization
{
    [InitializableModule]
    [ModuleDependency(typeof(EPiServer.Web.InitializationModule))]
    public class UIDefaultsInitialization : IInitializableModule
    {
        public void Initialize(InitializationEngine context)
        {
            // The supported default editor wrapper types are flyout and floating.
            context.Locate.Advanced.GetInstance<CmsUIDefaults>().DefaultEditorWrapper = UiWrapperType.Flyout;
        }

        public void Preload(string[] parameters) { }

        public void Uninitialize(InitializationEngine context) { }
    }
}

In the example above you can see that on initialize we simply set the default editor wrapper property on the UI defaults object. This defaults object is stores as a singleton within the service locator.

Comments