This documentation is archived and is not being maintained.

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.

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.

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: