DashboardXpoDataSource Class

Retrieves data from XPO (eXpress Persistent Objects).

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v21.2.Core.dll

Declaration

C#

public class DashboardXpoDataSource :
    XPObjectSource,
    IDashboardDataSource,
    IDashboardComponent,
    IComponent,
    IDisposable,
    ISupportInitialize,
    ISupportPrefix,
    IDashboardDataSourceInternal,
    IExternalSchemaConsumer,
    IFederationDataProvider,
    IXpoDataSourceInfo,
    ICloneable<DashboardXpoDataSource>

VB.NET

Public Class DashboardXpoDataSource
    Inherits XPObjectSource
    Implements IDashboardDataSource,
               IDashboardComponent,
               IComponent,
               IDisposable,
               ISupportInitialize,
               ISupportPrefix,
               IDashboardDataSourceInternal,
               IExternalSchemaConsumer,
               IFederationDataProvider,
               IXpoDataSourceInfo,
               ICloneable(Of DashboardXpoDataSource)

Remarks

The DashboardXpoDataSource allows you to obtain data that XPO (eXpress Persistent Object) retrieves from a data source.

Runtime

1. Create a DashboardXpoDataSource object and use the ConnectionStringName property to specify the name of the connection string defined in the application configuration file.

2. Pass the persistent object type to the SetEntityType method.

View Example: How to Bind a Dashboard to the XPO Data Source at Runtime

The code sample below illustrates how to connect to the XPO data source.

C#

using DevExpress.DashboardCommon;
// ...
public static DashboardXpoDataSource CreateXpoDataSource()
{
    DashboardXpoDataSource dataSource = new DashboardXpoDataSource()
    {
        ConnectionStringName = "northwind"
    };
    dataSource.SetEntityType(typeof(nwind.Customers));
    return dataSource;
}

VB.NET

Imports DevExpress.DashboardCommon
' ...
Public Shared Function CreateXpoDataSource() As DashboardXpoDataSource
  Dim dataSource As New DashboardXpoDataSource() With {.ConnectionStringName = "northwind"}
  dataSource.SetEntityType(GetType(nwind.Customers))
  Return dataSource
End Function

Design Time

Refer to the following topic for information on how bind a Dashboard to an XPO Data Source at Design-Time: XPO Data Source

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardXpoDataSource class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-xpo-data-source/CS/DashboardXpoExample/Form1.cs#L29

Dashboard dashboard = new Dashboard();
DashboardXpoDataSource xpoDataSource = CreateXpoDataSource();

asp-net-web-forms-dashboard-register-data-sources/CS/WebFormsDashboardDataSources/Pages/XpoDashboard.aspx.cs#L18

// Register an XPO data source.
DashboardXpoDataSource xpoDataSource = new DashboardXpoDataSource("XPO Data Source");
xpoDataSource.ConnectionStringName = "NWindConnectionStringSQLite";

asp-net-mvc-dashboard-register-data-sources/CS/MvcDashboardDataSources/Configuration/XpoDataSourceConfigurator.cs#L8

// Registers an XPO data source.
DashboardXpoDataSource xpoDataSource = new DashboardXpoDataSource("XPO Data Source");
xpoDataSource.ConnectionStringName = "NWindConnectionStringSQLite";

VB.NET

winforms-dashboard-xpo-data-source/VB/DashboardXpoExample/Form1.vb#L27

Dim dashboard As New Dashboard()
Dim xpoDataSource As DashboardXpoDataSource = CreateXpoDataSource()

asp-net-web-forms-dashboard-register-data-sources/VB/WebFormsDashboardDataSources/Pages/XpoDashboard.aspx.vb#L18

' Register an XPO data source.
Dim xpoDataSource As DashboardXpoDataSource = New DashboardXpoDataSource("XPO Data Source")
xpoDataSource.ConnectionStringName = "NWindConnectionStringSQLite"

asp-net-mvc-dashboard-register-data-sources/VB/MvcDashboardDataSources/Configuration/XpoDataSourceConfigurator.vb#L8

' Registers an XPO data source.
Dim xpoDataSource As New DashboardXpoDataSource("XPO Data Source")
xpoDataSource.ConnectionStringName = "NWindConnectionStringSQLite"

Implements

IDataComponent

IDashboardDataSource

Inheritance

Object

MarshalByRefObject

Component

DataComponentBase

XPObjectSource

DashboardXpoDataSource