SaaS CMS has officially launched! Learn more now.

Interface IPluggableComponentDefinition

Defines a component that can be added or removed automatically in a view.

Namespace: EPiServer.Shell.ViewComposition
Assembly: EPiServer.Shell.dll
Version: 7.19.2
Syntax
public interface IPluggableComponentDefinition : IContainerMatcher

Properties

AllowedRoles

Gets the list of roles that are allowed to use this component.

Declaration
ICollection<string> AllowedRoles { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<System.String>

The role list .

IsAvailableForUserSelection

Gets a value indicating whether this component should be selectable by a user when customizing a panel.

Declaration
bool IsAvailableForUserSelection { get; }
Property Value
Type Description
System.Boolean

If this component should be selectable by a user when customizing a panel.

SupportsAutomaticRegistration

Gets a value indicating whether this definition can be plugged in automatically to an IContainer.

Declaration
bool SupportsAutomaticRegistration { get; }
Property Value
Type Description
System.Boolean

true if this definition can be plugged in automatically; otherwise, false.

Methods

CreateComponent()

Creates the component corresponding to this component definition.

Declaration
IComponent CreateComponent()
Returns
Type Description
IComponent

A new instance of an IComponent.

Remarks

This method should not perform any access control validation.

HasAccess(IPrincipal)

Determines whether the specified principal has access to this component.

Declaration
bool HasAccess(IPrincipal principal)
Parameters
Type Name Description
System.Security.Principal.IPrincipal principal

The principal.

Returns
Type Description
System.Boolean

true if the specified principal has access; otherwise, false.

Extension Methods