Dashboard Members

Constructors

Name Description
Dashboard()

Initializes a new instance of the Dashboard class with default settings.

Properties

Name Description
ColorScheme

Provides access to a dashboard color scheme.

CurrencyCultureName

Gets or sets the default currency for the Dashboard.

DataConnections

For internal use.

DataSources

Gets the collection of dashboard data sources.

EnableAutomaticUpdates

Gets or sets whether or not automatic updates are enabled for the current dashboard.

Groups

Provides access to a collection of dashboard item groups.

IsDisposed

For internal use.

Items

Gets the collection of dashboard items.

LayoutRoot

Gets or sets the root dashboard layout group.

Parameters

Provides access to dashboard parameters.

Title

Provides access to the title settings of the dashboard.

UserData

Gets or sets custom data to be saved to the dashboard XML definition.

Methods

Name Description
AddDataSource(String, Object)

Obsolete. Adds a data source bound to the specified data and with the specified name to the Dashboard.DataSources collection.

BeginInit()

For internal use.

BeginUpdate()

Locks the Dashboard object by preventing updates until the Dashboard.EndUpdate method is called.

BeginUpdateLayout()

Obsolete. Locks the Dashboard object by preventing layout updates until the Dashboard.EndUpdateLayout method is called.

CreateGroup()

Creates a dashboard item group belonging to the current dashboard.

EndInit()

For internal use.

EndUpdate()

Unlocks the Dashboard object after a call to the Dashboard.BeginUpdate method and causes an immediate update.

EndUpdateLayout()

Obsolete. Unlocks the Dashboard object after a call to the Dashboard.BeginUpdateLayout method and causes an immediate layout update.

LoadFromXDocument(XDocument)

Loads the dashboard from the specified XML document.

LoadFromXml(Stream)

Loads a dashboard from the specified stream.

LoadFromXml(String)

Loads a dashboard from the specified XML file.

LoadUserDataFromXml(Stream)

Loads user data from the specified stream.

LoadUserDataFromXml(String)

Loads user data from the specified dashboard XML file.

RebuildLayout()

Updates the dashboard layout tree according to the current dashboard object model with the default size settings.

RebuildLayout(Int32, Int32)

Updates the dashboard layout tree according to the current dashboard object model with the specified width and height.

SaveToXDocument()

Saves the current dashboard to an XML document.

SaveToXml(Stream)

Saves the dashboard to the specified stream.

SaveToXml(String)

Saves the dashboard to the specified XML file.

Events

Name Description
ConfigureDataConnection

Allows you to customize connection settings before the connection to a data store (database, OLAP cube, etc.) is established.

ConnectionError

Allows overriding the default behavior when current connection parameters do not allow connecting to a data store.

CustomAssemblyLoading

Occurs before a custom assembly is loaded for use as a DashboardEFDataSource.

CustomFilterExpression

Allows you to include WHERE clauses into DashboardSqlDataSource queries.

CustomParameters

Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.

DashboardLoading

Occurs when the Dashboard Designer or Dashboard Viewer loads a dashboard.

DataLoading

Allows you to provide data for the DashboardObjectDataSource.

DataLoadingError

Allows you to suppress the form containing errors that occur during data loading.

DataSourceCollectionChanged

Occurs after the collection of data sources has been changed.

GroupCollectionChanged

Occurs after the collection of dashboard item groups is changed.

ItemCollectionChanged

Occurs after the collection of dashboard items has been changed.

OptionsChanged

Occurs after some option of the Dashboard was changed.

ParameterCollectionChanged

Occurs after the collection of dashboard parameters has been changed.

ValidateCustomSqlQuery

Provides the capability to check the validity of the custom SQL query used to supply the dashboard with data.