This documentation is archived and is not being maintained.

ConstraintCollection.Add Method (String, DataColumn, DataColumn)

Constructs a new ForeignKeyConstraint with the specified name, parent column, and child column, and adds the constraint to the collection.

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

public Constraint Add(
	string name,
	DataColumn primaryKeyColumn,
	DataColumn foreignKeyColumn
)

Parameters

name
Type: System.String

The name of the ForeignKeyConstraint.

primaryKeyColumn
Type: System.Data.DataColumn

The primary key, or parent, DataColumn.

foreignKeyColumn
Type: System.Data.DataColumn

The foreign key, or child, DataColumn.

The CollectionChanged event occurs if the constraint is added successfully.

The following example adds a new ForeignKeyConstraint to the ConstraintCollection of a DataTable.

private void AddForeignConstraint(DataSet dataSet)
{
    try
    {
        DataColumn parentColumn = 
            dataSet.Tables["Suppliers"].Columns["SupplierID"];
        DataColumn childColumn = 
            dataSet.Tables["Products"].Columns["SupplierID"];
        dataSet.Tables["Products"].Constraints.Add
            ("ProductsSuppliers", parentColumn, childColumn);
    }
    catch(Exception ex)
    {
        // In case the constraint already exists,  
        // catch the collision here and respond.
        Console.WriteLine("Exception of type {0} occurred.", 
            ex.GetType());
    }
}

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: