DashboardDesigner.CustomDBSchemaProviderEx Property

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

Namespace: DevExpress.DashboardWin

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

Declaration

C#

[DefaultValue(null)]
[Browsable(false)]
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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-dashboard-designer-how-to-customize-a-data-store-schema-for-sql-data-sources-e5051.

Form1.cs

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

namespace Dashboard_CustomSchemaProvider {
    public partial class Form1 : RibbonForm {
        public Form1() {
            InitializeComponent();
            dashboardDesigner1.CreateRibbon();

            // Specifies a custom schema provider.
            dashboardDesigner1.CustomDBSchemaProviderEx = new CustomDBSchemaProvider();

            // Loads a dashboard from an XML file.
            dashboardDesigner1.LoadDashboard(@"..\..\Data\dashboard.xml");
        }

        // 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 productNameColumn = new DBColumn {Name = "ProductName"};
                        table.AddColumn(productNameColumn);

                        DBForeignKey foreignKey = new DBForeignKey(
                            new[] { categoryIdColumn },
                            "Categories",
                            CustomDBSchemaProvider.CreatePrimaryKeys("CategoryID"));
                        table.ForeignKeys.Add(foreignKey);
                    }
                }
            }

            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 == @"..\..\Data\nwind.mdb") {
                    if (tables != null) {
                        return tables;
                    }
                    tables = new DBTable[2];

                    DBTable categoriesTable = new DBTable("Categories");
                    tables[0] = categoriesTable;

                    DBTable productsTable = new DBTable("Products");
                    tables[1] = productsTable;                  
                }
                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.vb

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

Namespace Dashboard_CustomSchemaProvider
    Partial Public Class Form1
        Inherits RibbonForm

        Public Sub New()
            InitializeComponent()
            dashboardDesigner1.CreateRibbon()

            ' Specifies a custom schema provider.
            dashboardDesigner1.CustomDBSchemaProviderEx = New CustomDBSchemaProvider()

            ' Loads a dashboard from an XML file.
            dashboardDesigner1.LoadDashboard("..\..\Data\dashboard.xml")
        End Sub

        ' Creates a new class that defines a custom data store schema by implementing the 
        ' IDBSchemaProvider interface.
        Private 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 productNameColumn As DBColumn = New DBColumn With {.Name = "ProductName"}
                        table.AddColumn(productNameColumn)

                        Dim foreignKey As New DBForeignKey({categoryIdColumn},
                                                           "Categories",
                                                           CustomDBSchemaProvider.CreatePrimaryKeys("CategoryID"))
                        table.ForeignKeys.Add(foreignKey)
                    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 = "..\..\Data\nwind.mdb" Then
                    If tables IsNot Nothing Then
                        Return tables
                    End If
                    tables = New DBTable(1) {}

                    Dim categoriesTable As New DBTable("Categories")
                    tables(0) = categoriesTable

                    Dim productsTable As New DBTable("Products")
                    tables(1) = productsTable
                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 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-designer-how-to-customize-a-data-store-schema-for-sql-data-sources-e5051/CS/Dashboard_CustomSchemaProvider/Form1.cs#L22

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

VB.NET

winforms-dashboard-designer-how-to-customize-a-data-store-schema-for-sql-data-sources-e5051/VB/Dashboard_CustomSchemaProvider/Form1.vb#L22

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