SaaS CMS has officially launched! Learn more now.

Interface IComponent

Defines the settings for a component.

Namespace: EPiServer.Shell.ViewComposition
Assembly: EPiServer.Shell.dll
Version: 8.11.0
Syntax
public interface IComponent

Properties

DefinitionName

Unique name of the component type.

Declaration
string DefinitionName { get; }
Property Value
Type Description
System.String

The unique name that is used to create new IComponents from the IComponentProviders.

Id

Gets or sets the id.

Declaration
Guid Id { get; set; }
Property Value
Type Description
System.Guid

ModuleName

Gets the name of the Shell module to which the component belongs to.

Declaration
string ModuleName { get; }
Property Value
Type Description
System.String

The name of the Shell module.

Settings

Gets the settings collection for this component. Used for client activation and persisted on the server.

Declaration
ISettingsDictionary Settings { get; }
Property Value
Type Description
ISettingsDictionary

SortOrder

Gets or sets the sort order for this component.

Declaration
int SortOrder { get; set; }
Property Value
Type Description
System.Int32

WidgetType

Gets the widget type used when displaying the component.

Declaration
string WidgetType { get; }
Property Value
Type Description
System.String