DataRelationCollection.Add Method (String, DataColumn[], DataColumn[], Boolean)

 

Creates a DataRelation with the specified name, arrays of parent and child columns, and value specifying whether to create a constraint, 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,
	bool createConstraints
)

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.

createConstraints
Type: System.Boolean

true to create a constraint; otherwise false.

Return Value

Type: System.Data.DataRelation

The created relation.

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.

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

.NET Framework
Available since 1.1
Return to top
Show: