Interface IComponentDefinition
Defines information about a component. This can be used when creating lists of selectable components for a user.
Inherited Members
System.IEquatable<EPiServer.Shell.ViewComposition.IComponentDefinition>.Equals(EPiServer.Shell.ViewComposition.IComponentDefinition)
Namespace: EPiServer.Shell.ViewComposition
Assembly: EPiServer.Shell.dll
Version: 9.12.2Syntax
public interface IComponentDefinition : IPluggableComponentDefinition, IContainerMatcher, IEquatable<IComponentDefinition>Properties
Categories
Gets or sets the category for this component. For example "cms".
Declaration
IEnumerable<string> Categories { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | The category. |
DefinitionName
Unique name of the component definition.
Declaration
string DefinitionName { get; }Property Value
| Type | Description |
|---|---|
| System.String | The unique name of the component definition. |
Remarks
This is used when creating component from a IComponentProvider. For instance, it can use the System.Type.FullName of the type of the IComponentDefinition.
Description
Description of the component. Should be localized.
Declaration
string Description { get; }Property Value
| Type | Description |
|---|---|
| System.String | The description. |
Title
Title used in the UI both for listings and as default for component instances. Should be localized.
Declaration
string Title { get; }Property Value
| Type | Description |
|---|---|
| System.String | The title. |
WidgetType
Name of the widget type to use for displaying the component.
Declaration
string WidgetType { get; }Property Value
| Type | Description |
|---|---|
| System.String | The name of the widget type to use for displaying the component. |
