SaaS CMS has officially launched! Learn more now.

Interface IComponentProvider

Definition of a provider for IComponents. Provides a list of IComponentDefinitions and the functionality to create IComponents from the definitions.

Inherited Members
Namespace: EPiServer.Shell.ViewComposition
Assembly: EPiServer.Shell.dll
Version: 8.11.0
Syntax
public interface IComponentProvider : ISortable

Methods

CreateComponent(IComponentDefinition)

Creates component instance corresponding to an IComponentDefinition.

Declaration
IComponent CreateComponent(IComponentDefinition definition)
Parameters
Type Name Description
IComponentDefinition definition

The component definition to create a component for.

Returns
Type Description
IComponent

A component instance if one could be created; otherwise null.

Remarks

This method should not perform any access control validation.

GetComponentDefinitions()

Gets the components that this provider provides.

Declaration
IEnumerable<IComponentDefinition> GetComponentDefinitions()
Returns
Type Description
System.Collections.Generic.IEnumerable<IComponentDefinition>

An System.Collections.Generic.IEnumerable<T> with the component definitions that this provider handles.