Class Dashboard

Inheritance
System.Object
Dashboard
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.Dashboard
Assembly: EPiServer.Shell.dll
Version: 11.20.7
Syntax
[EPiServerDataTable(TableName = "tblSystemBigTable")]
[EPiServerDataStore(StoreName = "DashboardStore")]
[Obsolete("The EPiServer 6 Dashboard has been replaced with EPiServer.ViewComposition namespace.")]
public class Dashboard : ICloneable

Constructors

Dashboard()

Declaration
public Dashboard()

Properties

Id

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

Tabs

Declaration
public Collection<Tab> Tabs { get; }
Property Value
Type Description
System.Collections.ObjectModel.Collection<Tab>

UserName

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

Methods

AddTab(Tab)

Declaration
public void AddTab(Tab tab)
Parameters
Type Name Description
Tab tab

Clone()

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

GetActiveTabs()

Declaration
public IEnumerable<Tab> GetActiveTabs()
Returns
Type Description
System.Collections.Generic.IEnumerable<Tab>

RemoveGadgetsMarkedAsDeleted()

Declaration
public void RemoveGadgetsMarkedAsDeleted()

TryGetContainer(Guid, out Container)

Declaration
public bool TryGetContainer(Guid containerId, out Container container)
Parameters
Type Name Description
System.Guid containerId
Container container
Returns
Type Description
System.Boolean

TryGetGadget(Guid, out Gadget)

Declaration
public bool TryGetGadget(Guid gadgetId, out Gadget gadget)
Parameters
Type Name Description
System.Guid gadgetId
Gadget gadget
Returns
Type Description
System.Boolean

TryGetTab(Guid, out Tab)

Declaration
public bool TryGetTab(Guid tabId, out Tab tab)
Parameters
Type Name Description
System.Guid tabId
Tab tab
Returns
Type Description
System.Boolean

TryMoveGadget(Guid, Guid, Int32)

Declaration
public bool TryMoveGadget(Guid gadgetId, Guid containerId, int indexPosition)
Parameters
Type Name Description
System.Guid gadgetId
System.Guid containerId
System.Int32 indexPosition
Returns
Type Description
System.Boolean

TryMoveTab(Guid, Int32)

Declaration
public bool TryMoveTab(Guid tabId, int indexPosition)
Parameters
Type Name Description
System.Guid tabId
System.Int32 indexPosition
Returns
Type Description
System.Boolean

TryRemoveGadget(Guid)

Declaration
public bool TryRemoveGadget(Guid gadgetId)
Parameters
Type Name Description
System.Guid gadgetId
Returns
Type Description
System.Boolean

TryRemoveTab(Guid)

Declaration
public bool TryRemoveTab(Guid tabId)
Parameters
Type Name Description
System.Guid tabId
Returns
Type Description
System.Boolean

TryRestoreGadget(Guid)

Declaration
public bool TryRestoreGadget(Guid gadgetId)
Parameters
Type Name Description
System.Guid gadgetId
Returns
Type Description
System.Boolean

TryRestoreTab(Guid)

Declaration
public bool TryRestoreTab(Guid tabId)
Parameters
Type Name Description
System.Guid tabId
Returns
Type Description
System.Boolean

Implements

System.ICloneable

Extension Methods