Class Dashboard

Dashboard is the aggregate root for the Dashboard application

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: 8.11.0

Syntax

[Obsolete("The EPiServer 6 Dashboard has been replaced with EPiServer.ViewComposition namespace.")]
public class Dashboard : ICloneable

Constructors

Dashboard()

Initializes a new instance of the Dashboard class.

Declaration

public Dashboard()

Properties

Id

Dashboard Id

Declaration

public Guid Id { get; set; }

Property Value

Type	Description
System.Guid

Tabs

Gets the tab list.

Declaration

public Collection<Tab> Tabs { get; }

Property Value

Type	Description
System.Collections.ObjectModel.Collection<Tab>	The tabs list.

UserName

Gets or sets the name of the user owning this Dashboard instance.

Declaration

public string UserName { get; set; }

Property Value

Type	Description
System.String	The name of the user.

Methods

AddTab(Tab)

Adds a tab.

Declaration

public void AddTab(Tab tab)

Parameters

Type	Name	Description
Tab	tab	The tab.

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.

GetActiveTabs()

Gets the active tabs.

Declaration

public IEnumerable<Tab> GetActiveTabs()

Returns

Type	Description
System.Collections.Generic.IEnumerable<Tab>

RemoveGadgetsMarkedAsDeleted()

Cleans the dasboard from all Tab and Gadget instances that has been marked with IsDeleted.

Declaration

public void RemoveGadgetsMarkedAsDeleted()

TryGetContainer(Guid, out Container)

Tries to get a container.

Declaration

public bool TryGetContainer(Guid containerId, out Container container)

Parameters

Type	Name	Description
System.Guid	containerId	The container id.
Container	container	The container.

Returns

Type	Description
System.Boolean	true if successful

TryGetGadget(Guid, out Gadget)

Tries to get a gadget.

Declaration

public bool TryGetGadget(Guid gadgetId, out Gadget gadget)

Parameters

Type	Name	Description
System.Guid	gadgetId	The gadget id.
Gadget	gadget	The gadget.

Returns

Type	Description
System.Boolean	true if successful

TryGetTab(Guid, out Tab)

Tries to get a tab.

Declaration

public bool TryGetTab(Guid tabId, out Tab tab)

Parameters

Type	Name	Description
System.Guid	tabId	The tab id.
Tab	tab	The tab.

Returns

Type	Description
System.Boolean

TryMoveGadget(Guid, Guid, Int32)

Tries to move a gadget.

Declaration

public bool TryMoveGadget(Guid gadgetId, Guid containerId, int indexPosition)

Parameters

Type	Name	Description
System.Guid	gadgetId	The gadget id of the Gadget to move.
System.Guid	containerId	The container id of the Container to move to.
System.Int32	indexPosition	The index position to move to.

Returns

Type	Description
System.Boolean

TryMoveTab(Guid, Int32)

Tries to move a tab.

Declaration

public bool TryMoveTab(Guid tabId, int indexPosition)

Parameters

Type	Name	Description
System.Guid	tabId	The tab id.
System.Int32	indexPosition	The index position to move to.

Returns

Type	Description
System.Boolean

TryRemoveGadget(Guid)

Tries to remove a gadget.

Declaration

public bool TryRemoveGadget(Guid gadgetId)

Parameters

Type	Name	Description
System.Guid	gadgetId	The gadget id.

Returns

Type	Description
System.Boolean

TryRemoveTab(Guid)

Tries to removes a tab.

Declaration

public bool TryRemoveTab(Guid tabId)

Parameters

Type	Name	Description
System.Guid	tabId	The tab id to remove.

Returns

Type	Description
System.Boolean

TryRestoreGadget(Guid)

Tries to restore a gadget.

Declaration

public bool TryRestoreGadget(Guid gadgetId)

Parameters

Type	Name	Description
System.Guid	gadgetId	The gadget id.

Returns

Type	Description
System.Boolean

TryRestoreTab(Guid)

Tries to restore a tab.

Declaration

public bool TryRestoreTab(Guid tabId)

Parameters

Type	Name	Description
System.Guid	tabId	The tab id.

Returns

Type	Description
System.Boolean

Implements

System.ICloneable