Add Method (String, DataColumn[], DataColumn[])

DataRelationCollection.Add Method (String, DataColumn(), DataColumn())


Creates a DataRelation with the specified name and arrays of parent and child columns, and adds it to the collection.

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

Public Overridable Function Add (
	name As String,
	parentColumns As DataColumn(),
	childColumns As DataColumn()
) As DataRelation


Type: System.String

The name of the DataRelation to create.

Type: System.Data.DataColumn()

An array of parent DataColumn objects.

Type: System.Data.DataColumn()

An array of child DataColumn objects.

Return Value

Type: System.Data.DataRelation

The created DataRelation.

Exception Condition

The relation name is a null value.


The relation already belongs to this collection, or it belongs to another collection.


The collection already has a relation with the same name. (The comparison is not case sensitive.)


The relation has entered an invalid state since it was created.

If the relation is successfully added to the collection, the CollectionChanged event occurs.

When a DataRelation object is added to the collection, ForeignKeyConstraint and UniqueConstraint objects are created by default if they do not already exist.

Private Sub AddRelation()
    Dim table As New DataTable()
    Dim column1 As DataColumn = table.Columns.Add("Column1")
    Dim column2 As DataColumn = table.Columns.Add("Column2")
    table.ChildRelations.Add("New Relation", column1, column2)
End Sub

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft