.NET Framework Class Library
DataRelationCollection..::.Add Method (String, DataColumn, DataColumn, Boolean)

Creates a DataRelation with the specified name, parent and child columns, with optional constraints according to the value of the createConstraints parameter, and adds it to the collection.

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

Visual Basic (Declaration)
Public Overridable Function Add ( _
    name As String, _
    parentColumn As DataColumn, _
    childColumn As DataColumn, _
    createConstraints As Boolean _
) As DataRelation
Visual Basic (Usage)
Dim instance As DataRelationCollection
Dim name As String
Dim parentColumn As DataColumn
Dim childColumn As DataColumn
Dim createConstraints As Boolean
Dim returnValue As DataRelation

returnValue = instance.Add(name, parentColumn, _
    childColumn, createConstraints)
C#
public virtual DataRelation Add(
    string name,
    DataColumn parentColumn,
    DataColumn childColumn,
    bool createConstraints
)
Visual C++
public:
virtual DataRelation^ Add(
    String^ name, 
    DataColumn^ parentColumn, 
    DataColumn^ childColumn, 
    bool createConstraints
)
JScript
public function Add(
    name : String, 
    parentColumn : DataColumn, 
    childColumn : DataColumn, 
    createConstraints : boolean
) : DataRelation

Parameters

name
Type: System..::.String
The name of the relation.
parentColumn
Type: System.Data..::.DataColumn
The parent column of the relation.
childColumn
Type: System.Data..::.DataColumn
The child column of the relation.
createConstraints
Type: System..::.Boolean
true to create constraints; otherwise false. (The default is true).

Return Value

Type: System.Data..::.DataRelation
The created relation.
Remarks

When a DataRelation object is added to the collection, ForeignKeyConstraint and UniqueConstraint objects are created by default if they do not already exist. To prevent this, you can set createConstraints to false.

Platforms

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

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

Reference

Other Resources

Tags :


Page view tracker