SaaS CMS has officially launched! Learn more now.

Class ContainerBase

Serves as a base for layout containers.

Implements
System.ICloneable
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: 7.19.2
Syntax
public abstract class ContainerBase : ComponentBase, IContainer, IComponent, ICloneable

Constructors

ContainerBase(String)

Initializes a new instance of the ContainerBase class.

Declaration
protected ContainerBase(string widgetType)
Parameters
Type Name Description
System.String widgetType

ContainerBase(String, ISettingsDictionary)

Initializes a new instance of the ContainerBase class.

Declaration
protected ContainerBase(string widgetType, ISettingsDictionary settings)
Parameters
Type Name Description
System.String widgetType

Type of the widget.

ISettingsDictionary settings

The settings.

Properties

Components

Gets or sets the components.

Declaration
public IList<IComponent> Components { get; }
Property Value
Type Description
System.Collections.Generic.IList<IComponent>

The components.

ContainerType

Gets or sets the type of the container.

Declaration
public ContainerType ContainerType { get; set; }
Property Value
Type Description
ContainerType

The type of the container.

PlugInArea

The plug-in area that is used to plug-in components automatically.

Declaration
public string PlugInArea { get; set; }
Property Value
Type Description
System.String

Methods

Add(IComponent)

Adds a component to the collection.

Declaration
public IContainer Add(IComponent component)
Parameters
Type Name Description
IComponent component

The component.

Returns
Type Description
IContainer

Clone()

Creates a new object that is a copy of the current instance.

Declaration
public object Clone()
Returns
Type Description
System.Object

A new object that is a copy of this instance.

SortComponents(Comparison<IComponent>)

Sort the components using the specified comparison delegate.

Declaration
public void SortComponents(Comparison<IComponent> comparison)
Parameters
Type Name Description
System.Comparison<IComponent> comparison

The comparison delegate determining the new component order.

Implements

System.ICloneable

Extension Methods