Class ComponentBase

Serves as a base for layout containers

Inheritance

System.Object

ComponentBase

ContainerBase

Implements

IComponent

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.Shell.ViewComposition

Assembly: EPiServer.Shell.dll

Version: 8.11.0

Syntax

public abstract class ComponentBase : IComponent

Constructors

ComponentBase(String)

Initializes and sets as active new instance of the ComponentBase class.

Declaration

protected ComponentBase(string widgetType)

Parameters

Type	Name	Description
System.String	widgetType

ComponentBase(String, ISettingsDictionary)

Initializes a new instance of the ComponentBase class.

Declaration

protected ComponentBase(string widgetType, ISettingsDictionary settings)

Parameters

Type	Name	Description
System.String	widgetType	Type of the widget.
ISettingsDictionary	settings	The initial settings.

ComponentBase(String, Guid, ISettingsDictionary)

Initializes a new instance of the ComponentBase class.

Declaration

protected ComponentBase(string widgetType, Guid id, ISettingsDictionary settings)

Parameters

Type	Name	Description
System.String	widgetType	Type of the widget.
System.Guid	id	The id.
ISettingsDictionary	settings	The initial settings.

Properties

DefinitionName

Unique name of the component type.

Declaration

public virtual string DefinitionName { get; }

Property Value

Type	Description
System.String	The unique name that is used to create new IComponents from the IComponentProviders.

Heading

Gets or sets a heading used client side for the component.

Declaration

public string Heading { get; set; }

Property Value

Type	Description
System.String

Id

The System.Guid of the item

Declaration

public 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

public virtual 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

public ISettingsDictionary Settings { get; }

Property Value

Type	Description
ISettingsDictionary

SortOrder

Gets or sets the sort order for this component.

Declaration

public int SortOrder { get; set; }

Property Value

Type	Description
System.Int32

WidgetType

Name of the widget type to use for displaying the component.

Declaration

public string WidgetType { get; }

Property Value

Type	Description
System.String	The name of the widget type to use for displaying the component.

Methods

GetModuleName()

Gets the name of the module.

Declaration

protected virtual string GetModuleName()

Returns

Type	Description
System.String

GetModuleName(Type)

Returns a ShellModule to which a specified Type belongs.

Declaration

protected string GetModuleName(Type type)

Parameters

Type	Name	Description
System.Type	type	The type.

Returns

Type	Description
System.String

Implements

IComponent