dashboard-devexpress-dot-dashboardcommon-dot-dashboard-dot-underscore-members.md
Contains the full description of a dashboard used to visualize data.
| Name | Description |
|---|---|
| Dashboard() | Initializes a new instance of the Dashboard class with default settings. |
| Name | Description |
|---|---|
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| ColorScheme | Provides access to a dashboard color scheme. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| CurrencyCultureName | Gets or sets the default currency for the Dashboard. |
| CustomItemMetadataTypes static | Gets a collection of metadata types that correspond to metadata descendants. |
| CustomProperties | Gets custom properties available for the current dashboard. |
| DataConnections | For internal use. |
| DataSources | Gets the collection of dashboard data sources. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| EnableAutomaticUpdates | Gets or sets whether automatic updates are enabled for the current dashboard. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| Groups | Provides access to a collection of dashboard item groups. |
| IsDisposed | For internal use. |
| Items | Gets the collection of dashboard items. |
| LayoutOptions | Provides access to the dashboard layout settings. |
| LayoutRoot | Gets or sets the root dashboard layout group. |
| Parameters | Provides access to dashboard parameters. |
| RequestParameters | Specifies whether to load dashboard data only after the user submits the parameter values. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| Title | Provides access to the title settings of the dashboard. |
| UserData | Gets or sets custom data to be saved to the dashboard XML definition. |
| Name | Description |
|---|---|
| BeginInit() | For internal use. |
| BeginUpdate() | Locks the Dashboard object by preventing updates until the Dashboard.EndUpdate method is called. |
| Clone() | |
| CreateGroup() | Creates a dashboard item group belonging to the current dashboard. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| EndInit() | For internal use. |
| EndUpdate() | Unlocks the Dashboard object after a call to the Dashboard.BeginUpdate method and causes an immediate update. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| 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) static | Loads user data from the specified stream. |
| LoadUserDataFromXml(String) static | Loads user data from the specified dashboard XML file. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| 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. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| 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. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
| Name | Description |
|---|---|
| ConfigureDataConnection | Allows you to customize connection settings before the connection to a data store (database, OLAP cube, etc.) is established. |
| ConnectionError | Allows users to override the default behavior if data store connection fails with current connection parameters. |
| 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. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| 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 any option in the current Dashboard is 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. |
See Also