Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Add Method (String, DataColumn, DataColumn)

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.

Return Value

Type: System.Data.Constraint
A new ForeignKeyConstraint.

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());
    }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show:
© 2015 Microsoft