DashboardDesigner.CustomDBSchemaProviderEx Property

Allows you to specify a custom schema for the SQL Data Source.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

[Browsable(false)]
[DefaultValue(null)]
public IDBSchemaProviderEx CustomDBSchemaProviderEx { get; set; }

VB.NET

<DefaultValue(Nothing)>
<Browsable(False)>
Public Property CustomDBSchemaProviderEx As IDBSchemaProviderEx

Property Value

Type	Default	Description
IDBSchemaProviderEx	null	An object that implements the IDBSchemaProviderEx interface that provides a custom schema.

Example

This example demonstrates how to customize a data store schema for a dashboard data source that uses a connection to the Northwind database.

In this example, the IDBSchemaProviderEx interface is implemented by a class that defines a custom data store schema containing two related tables. The IDBSchemaProviderEx.GetTables method returns tables and columns which will be included to a data store schema.

To see the result, add a new query or edit the existing query.

View Example

CustomDBSchemaProvider.cs

using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
using DevExpress.Xpo.DB;
using System.Collections.Specialized;

namespace Dashboard_CustomSchemaProvider {
    // Creates a new class that defines a custom data store schema by implementing the 
    // IDBSchemaProvider interface.
    class CustomDBSchemaProvider : IDBSchemaProviderEx {
        DBTable[] tables;
        public void LoadColumns(SqlDataConnection connection, params DBTable[] tables) {
            foreach (DBTable table in tables) {
                if (table.Name == "Categories" && table.Columns.Count == 0) {
                    DBColumn categoryIdColumn = new DBColumn { Name = "CategoryID" };
                    table.AddColumn(categoryIdColumn);
                    DBColumn categoryNameColumn = new DBColumn { Name = "CategoryName" };
                    table.AddColumn(categoryNameColumn);
                }
                if (table.Name == "Products" && table.Columns.Count == 0) {
                    DBColumn categoryIdColumn = new DBColumn { Name = "CategoryID" };
                    table.AddColumn(categoryIdColumn);
                    DBColumn supplierIdColumn = new DBColumn { Name = "SupplierID" };
                    table.AddColumn(supplierIdColumn);
                    DBColumn productNameColumn = new DBColumn { Name = "ProductName" };
                    table.AddColumn(productNameColumn);

                    DBForeignKey foreignKey1 = new DBForeignKey(
                        new[] { categoryIdColumn },
                        "Categories",
                        CustomDBSchemaProvider.CreatePrimaryKeys("CategoryID"));
                    table.ForeignKeys.Add(foreignKey1);
                    DBForeignKey foreignKey2 = new DBForeignKey(
                        new[] { supplierIdColumn },
                        "Suppliers",
                        CustomDBSchemaProvider.CreatePrimaryKeys("SupplierID"));
                    table.ForeignKeys.Add(foreignKey2);
                }
                if (table.Name == "Suppliers" && table.Columns.Count == 0) {
                    DBColumn supplierIdColumn = new DBColumn { Name = "SupplierID" };
                    table.AddColumn(supplierIdColumn);
                    DBColumn companyNameColumn = new DBColumn { Name = "CompanyName" };
                    table.AddColumn(companyNameColumn);
                }
            }
        }

        public static StringCollection CreatePrimaryKeys(params string[] names) {
            StringCollection collection = new StringCollection();
            collection.AddRange(names);
            return collection;
        }

        public DBTable[] GetTables(SqlDataConnection connection, params string[] tableList) {
            var cp = connection.ConnectionParameters as Access97ConnectionParameters;
            if (cp != null && cp.FileName.Contains("nwind.mdb")) {
                if (tables != null) {
                    return tables;
                }

                tables = new DBTable[3];
                tables[0] = new DBTable("Categories");
                tables[1] = new DBTable("Products");
                tables[2] = new DBTable("Suppliers");
            }
            else
                tables = new DBTable[0];
            return tables;
        }

        public DBTable[] GetViews(SqlDataConnection connection, params string[] viewList) {
            DBTable[] views = new DBTable[0];
            return views;
        }

        public DBStoredProcedure[] GetProcedures(SqlDataConnection connection, params string[] procedureList) {
            DBStoredProcedure[] storedProcedures = new DBStoredProcedure[0];
            return storedProcedures;
        }
    }
}

Form1.cs

using DevExpress.DashboardWin;

namespace Dashboard_CustomSchemaProvider {
    public partial class Form1 : DevExpress.XtraEditors.XtraForm {
        public Form1() {
            InitializeComponent();
            dashboardDesigner1.CreateRibbon();
            dashboardDesigner1.CustomizeDashboardTitle += DashboardDesigner1_CustomizeDashboardTitle;

            dashboardDesigner1.LoadDashboard(@"Data\dashboard-with-products.xml");
        }

        private void DashboardDesigner1_CustomizeDashboardTitle(object sender, DevExpress.DashboardWin.CustomizeDashboardTitleEventArgs e) {
            DashboardToolbarItem itemSave = new DashboardToolbarItem((args) => UseCustomDBSchemaProvider()) {
                Caption = "Use Custom DBSchema Provider",
            };
            e.Items.Clear();
            e.Items.Add(itemSave);
        }

        private void UseCustomDBSchemaProvider()         {
            dashboardDesigner1.CustomDBSchemaProviderEx = new CustomDBSchemaProvider();
        }
    }
}

CustomDBSchemaProvider.vb

Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
Imports DevExpress.Xpo.DB
Imports System.Collections.Specialized

Namespace Dashboard_CustomSchemaProvider
    ' Creates a new class that defines a custom data store schema by implementing the 
    ' IDBSchemaProvider interface.
    Friend Class CustomDBSchemaProvider
        Implements IDBSchemaProviderEx

        Private tables() As DBTable
        Public Sub LoadColumns(ByVal connection As SqlDataConnection, ParamArray ByVal tables() As DBTable) Implements IDBSchemaProviderEx.LoadColumns
            For Each table As DBTable In tables
                If table.Name = "Categories" AndAlso table.Columns.Count = 0 Then
                    Dim categoryIdColumn As DBColumn = New DBColumn With {.Name = "CategoryID"}
                    table.AddColumn(categoryIdColumn)
                    Dim categoryNameColumn As DBColumn = New DBColumn With {.Name = "CategoryName"}
                    table.AddColumn(categoryNameColumn)
                End If
                If table.Name = "Products" AndAlso table.Columns.Count = 0 Then
                    Dim categoryIdColumn As DBColumn = New DBColumn With {.Name = "CategoryID"}
                    table.AddColumn(categoryIdColumn)
                    Dim supplierIdColumn As DBColumn = New DBColumn With {.Name = "SupplierID"}
                    table.AddColumn(supplierIdColumn)
                    Dim productNameColumn As DBColumn = New DBColumn With {.Name = "ProductName"}
                    table.AddColumn(productNameColumn)

                    Dim foreignKey1 As New DBForeignKey( { categoryIdColumn }, "Categories", CustomDBSchemaProvider.CreatePrimaryKeys("CategoryID"))
                    table.ForeignKeys.Add(foreignKey1)
                    Dim foreignKey2 As New DBForeignKey( { supplierIdColumn }, "Suppliers", CustomDBSchemaProvider.CreatePrimaryKeys("SupplierID"))
                    table.ForeignKeys.Add(foreignKey2)
                End If
                If table.Name = "Suppliers" AndAlso table.Columns.Count = 0 Then
                    Dim supplierIdColumn As DBColumn = New DBColumn With {.Name = "SupplierID"}
                    table.AddColumn(supplierIdColumn)
                    Dim companyNameColumn As DBColumn = New DBColumn With {.Name = "CompanyName"}
                    table.AddColumn(companyNameColumn)
                End If
            Next table
        End Sub

        Public Shared Function CreatePrimaryKeys(ParamArray ByVal names() As String) As StringCollection
            Dim collection As New StringCollection()
            collection.AddRange(names)
            Return collection
        End Function

        Public Function GetTables(ByVal connection As SqlDataConnection, ParamArray ByVal tableList() As String) As DBTable() Implements IDBSchemaProviderEx.GetTables
            Dim cp = TryCast(connection.ConnectionParameters, Access97ConnectionParameters)
            If cp IsNot Nothing AndAlso cp.FileName.Contains("nwind.mdb") Then
                If tables IsNot Nothing Then
                    Return tables
                End If

                tables = New DBTable(2){}
                tables(0) = New DBTable("Categories")
                tables(1) = New DBTable("Products")
                tables(2) = New DBTable("Suppliers")
            Else
                tables = New DBTable(){}
            End If
            Return tables
        End Function

        Public Function GetViews(ByVal connection As SqlDataConnection, ParamArray ByVal viewList() As String) As DBTable() Implements IDBSchemaProviderEx.GetViews
            Dim views(-1) As DBTable
            Return views
        End Function

        Public Function GetProcedures(ByVal connection As SqlDataConnection, ParamArray ByVal procedureList() As String) As DBStoredProcedure() Implements IDBSchemaProviderEx.GetProcedures
            Dim storedProcedures(-1) As DBStoredProcedure
            Return storedProcedures
        End Function
    End Class
End Namespace

Form1.vb

Imports DevExpress.DashboardWin

Namespace Dashboard_CustomSchemaProvider
    Partial Public Class Form1
        Inherits DevExpress.XtraEditors.XtraForm

        Public Sub New()
            InitializeComponent()
            dashboardDesigner1.CreateRibbon()
            AddHandler dashboardDesigner1.CustomizeDashboardTitle, AddressOf DashboardDesigner1_CustomizeDashboardTitle

            dashboardDesigner1.LoadDashboard("Data\dashboard-with-products.xml")
        End Sub

        Private Sub DashboardDesigner1_CustomizeDashboardTitle(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.CustomizeDashboardTitleEventArgs)
            Dim itemSave As New DashboardToolbarItem(Sub(args) UseCustomDBSchemaProvider()) With {.Caption = "Use Custom DBSchema Provider"}
            e.Items.Clear()
            e.Items.Add(itemSave)
        End Sub

        Private Sub UseCustomDBSchemaProvider()
            dashboardDesigner1.CustomDBSchemaProviderEx = New CustomDBSchemaProvider()
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomDBSchemaProviderEx property.

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-custom-database-schema-for-sql-data-sources/CS/Dashboard_CustomSchemaProvider/Form1.cs#L12

// Uncomment one of the following lines depending on the provider.
dashboardDesigner1.CustomDBSchemaProviderEx = new ManualDBSchemaProvider();
// dashboardDesigner1.CustomDBSchemaProviderEx = new LimitDBSchemaProvider();

VB.NET

winforms-dashboard-custom-database-schema-for-sql-data-sources/VB/Dashboard_CustomSchemaProvider/Form1.vb#L12

    ' Uncomment one of the following lines depending on the provider.
    dashboardDesigner1.CustomDBSchemaProviderEx = New ManualDBSchemaProvider()
' dashboardDesigner1.CustomDBSchemaProviderEx = new LimitDBSchemaProvider();

Implements

CustomDBSchemaProviderEx