Interface IDashboardRepository

Acts as the link between the Dashboard and the data storage.

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 interface IDashboardRepository

Methods

Create(Dashboard)

Creates new dashboard in repository.

Declaration

void Create(Dashboard dashboard)

Parameters

Type	Name	Description
Dashboard	dashboard	The dashboard to create.

Delete(Dashboard)

Deletes the specified dashboard.

Declaration

void Delete(Dashboard dashboard)

Parameters

Type	Name	Description
Dashboard	dashboard	The dashboard to delete.

Save(Dashboard)

Saves the specified dashboard.

Declaration

void Save(Dashboard dashboard)

Parameters

Type	Name	Description
Dashboard	dashboard	The dashboard to save.

TryGet(Guid, out Dashboard)

Tries to get a Dashboard.

Declaration

bool TryGet(Guid id, out Dashboard dashboard)

Parameters

Type	Name	Description
System.Guid	id	The id of the dashboard.
Dashboard	dashboard	The dashboard.

Returns

Type	Description
System.Boolean	true if successful.

TryGet(String, out Dashboard)

Tries to get a Dashboard.

Declaration

bool TryGet(string userName, out Dashboard dashboard)

Parameters

Type	Name	Description
System.String	userName	The username.
Dashboard	dashboard	The dashboard.

Returns

Type	Description
System.Boolean	true if successful.

Events

Creating

Creating event

Declaration

event EventHandler<DashboardEventArgs> Creating

Event Type

Type	Description
System.EventHandler<DashboardEventArgs>

Deleting

Deleting event

Declaration

event EventHandler<DashboardEventArgs> Deleting

Event Type

Type	Description
System.EventHandler<DashboardEventArgs>

Loaded

Dashboard Loaded event

Declaration

event EventHandler<DashboardEventArgs> Loaded

Event Type

Type	Description
System.EventHandler<DashboardEventArgs>

Saving

Dashboard Saving event

Declaration

event EventHandler<DashboardEventArgs> Saving

Event Type

Type	Description
System.EventHandler<DashboardEventArgs>