Loading...
Area: Optimizely CMS
Applies to versions: 10 and higher
Other versions:

Hiding or controlling access to customized components

Recommended reading 

This topic describes how to manage access to customized components in the Optimizely user interface.

How it works

The AllowedRoles property for a component definitions lets you control the groups that are allowed to view and select a certain component. You can hide a component completely by setting the AllowedRoles property to none, or setting it to a null string which prevents an access check.

Example

The following example shows how to hide or show a certain component, depending on a global setting.

[Component]
    public class FileManagementComponent : ComponentDefinitionBase
    {
        public FileManagementComponent() : base("epi-cms.component.FileManagement")
        {
            Categories = new string[]{"cms"};
            LanguagePath = "/episerver/cms/components/filemanagement";
            SortOrder = 200;
            PlugInAreas = new string[] { PlugInArea.DefaultAssetsGroup };

            AllowedRoles.Clear();
            AllowedRoles.Add("none");
        }
    }

Do you find this information helpful? Please log in to provide feedback.

Last updated: Sep 28, 2021

Recommended reading