DataRelation Constructor (String, DataColumn[], DataColumn[])

DataRelation Constructor (String, DataColumn[], DataColumn[])

 

Initializes a new instance of the DataRelation class using the specified DataRelation name and matched arrays of parent and child DataColumn objects.

Namespace:   System.Data
Assembly:  System.Data (in System.Data.dll)

public DataRelation(
	string relationName,
	DataColumn[] parentColumns,
	DataColumn[] childColumns
)

Parameters

relationName
Type: System.String

The name of the relation. If null 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.

Exception Condition
ArgumentNullException

One or both of the DataColumn objects contains null.

InvalidConstraintException

The DataColumn objects have different data types

-Or-

One or both of the arrays are not composed of distinct columns from the same table.

-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")

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

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

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft