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 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.

Exception Condition
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
Available since 1.1
Return to top
Show:
© 2016 Microsoft