Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

DataRelation Constructor (String, DataColumn(), DataColumn(), Boolean)

Initializes a new instance of the DataRelation class using the specified name, matched arrays of parent and child DataColumn objects, and value that indicates whether to create constraints.

Namespace:  System.Data
Assembly:  System.Data (in System.Data.dll)
'Declaration
Public Sub New ( _
	relationName As String, _
	parentColumns As DataColumn(), _
	childColumns As DataColumn(), _
	createConstraints As Boolean _
)

Parameters

relationName
Type: System.String

The name of the relation. If Nothing or an empty string (""), a default name will be given when the created object is added to the DataRelationCollection.

parentColumns
Type: System.Data.DataColumn()

An array of parent DataColumn objects.

childColumns
Type: System.Data.DataColumn()

An array of child DataColumn objects.

createConstraints
Type: System.Boolean

A value that indicates whether to create constraints. true, if constraints are created. Otherwise, false.

ExceptionCondition
ArgumentNullException

One or both of the DataColumn objects is Nothing.

InvalidConstraintException

The columns have different data types

-Or-

The tables do not belong to the same DataSet.

The following example creates a new DataRelation and adds it to the DataRelationCollection of a DataSet.

Private Sub CreateRelation()
    ' Code to get the DataSet not shown here. 
    ' Get the DataColumn objects from two DataTable  
    ' objects in a DataSet. 
    Dim parentColumns() As DataColumn
    Dim childColumns() As DataColumn
    parentColumns(0) = DataSet1.Tables( _
        "Customers").Columns("CustID")
    parentColumns(1) = DataSet1.Tables( _
        "Customers").Columns("OrdID")

    childColumns(0) = DataSet1.Tables( _
        "Orders").Columns("CustID")
    childColumns(1) = DataSet1.Tables( _
        "Orders").Columns("OrdID")

    Dim bConstraints As Boolean = True 
    ' Create DataRelation. 
    Dim CustOrderRel As DataRelation = New DataRelation( _
        "CustomersOrders", parentColumns, childColumns,  _
        bConstraints)

    ' Add the relation to the DataSet.
    DataSet1.Relations.Add(CustOrderRel)
End Sub

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.