AddCrossProviderRelation Method

In This Topic

Syntax
Exceptions
Remarks
Requirements
See Also

Creates a (virtual) 1:n relation between two tables from this collection of data providers. The tables may belong to different data providers or to the same data provider. Please note that the support for custom relations depends on the capabilities of the involved data providers.

Any table of any data provider type can be specified as the parent table (primary key table). However only a table that supports filtering can be specified as the child table (table containing the foreign key). The support for filtering depends on the type of the data provider and may be tested with the SupportsFiltering property of a table object. Only when the parent table also supports filtering (this is optional), a 1:1 relation from rows of the child table to a row of the parent table will be offered in the Designer.

Internally, the data providers (or the database system that they are connected to) will need to compare the values of the specified parent/child columns. List & Label does not check if the data types of the parent/child columns can be compared. Therefore we recommend to only define relations on columns of the same data type.

See the remarks section for more information on supported data provider types.

Syntax

public void AddCrossProviderRelation( 
   string relationName,
   IDataProvider parentProvider,
   string parentTableName,
   string parentColumnName,
   IDataProvider childProvider,
   string childTableName,
   string childColumnName
)

public:
void AddCrossProviderRelation( 
   String^ relationName,
   IDataProvider^ parentProvider,
   String^ parentTableName,
   String^ parentColumnName,
   IDataProvider^ childProvider,
   String^ childTableName,
   String^ childColumnName
)

'Declaration
 
Public Sub AddCrossProviderRelation( _
   ByVal relationName As String, _
   ByVal parentProvider As IDataProvider, _
   ByVal parentTableName As String, _
   ByVal parentColumnName As String, _
   ByVal childProvider As IDataProvider, _
   ByVal childTableName As String, _
   ByVal childColumnName As String _
)

Parameters

relationName: Name of the relation
parentProvider: Dataprovider from which the parent table is used
parentTableName: Name of the parent table
parentColumnName: Name of the parent column
childProvider: Dataprovider from which the child table is used
childTableName: Name of the child table
childColumnName: Name of the child column

Exceptions

Exception	Description
ArgumentException	Thrown when the parentProvider or the childProvider are not contained in this data provider code, or when the child table does not support filtering.

Remarks

Filterable data providers that can be used as the parent or the child table:
All SQL-based databases (SQL Server, Oracle, MySQL, ...), OData, ODBC, OLE DB, MongoDB, Cassandra, Salesforce

Filterable when wrapped with the InMemoryDataProvider:
CSV, Excel

Unfilterable data providers that can be used only as parent table:
REST, JSON, XML, Google Analytics, Google BigQuery, Google Spreadsheet

Requirements

Platforms: Windows 10 (Version 21H2 - 23H2), Windows 11 (21H2 - 22H2), Windows Server 2016 - 2022
.NET: .NET Framework 4.8, .NET 6, .NET 8, .NET 9

Reference

DataProviderCollection Class
DataProviderCollection Members

Send Feedback