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 virtual DataRelation Add(
	string name,
	DataColumn[] parentColumns,
	DataColumn[] childColumns
)

Parameters

name
Type: System.String

The name of the DataRelation to create.

parentColumns
Type: System.Data.DataColumn[]

An array of parent DataColumn objects.

childColumns
Type: System.Data.DataColumn[]

An array of child DataColumn objects.

Return Value

Type: System.Data.DataRelation
The created DataRelation.

ExceptionCondition
ArgumentNullException

The relation name is a null value.

ArgumentException

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

DuplicateNameException

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

InvalidConstraintException

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 void AddRelation() 
{
    DataTable table = new DataTable();
    DataColumn column1 = table.Columns.Add("Column1");
    DataColumn column2 = table.Columns.Add("Column2");
    table.ChildRelations.Add("New Relation", column1, column2);
}

.NET Framework

Supported in: 4.5.2, 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 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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft