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

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

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

public DataRelation (
	string relationName,
	DataColumn parentColumn,
	DataColumn childColumn,
	bool createConstraints
)
public DataRelation (
	String relationName, 
	DataColumn parentColumn, 
	DataColumn childColumn, 
	boolean createConstraints
)
public function DataRelation (
	relationName : String, 
	parentColumn : DataColumn, 
	childColumn : DataColumn, 
	createConstraints : boolean
)
Not applicable.

Parameters

relationName

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

parentColumn

The parent DataColumn in the relation.

childColumn

The child DataColumn in the relation.

createConstraints

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

Exception typeCondition

ArgumentNullException

One or both of the DataColumn objects contains a null reference (Nothing in Visual Basic).

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 parentColumn As DataColumn = DataSet1.Tables( _
        "Customers").Columns("CustID")
    Dim childColumn As DataColumn = _
        DataSet1.Tables("Orders").Columns("CustID")

    ' Create DataRelation.
    Dim bConstraints As Boolean = True
    Dim customerOrdersRelation As DataRelation = _
        New DataRelation("CustomersOrders", _
        parentColumn, childColumn, bConstraints)

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Show: