ForeignKeyConstraint Constructor (String, DataColumn, DataColumn)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Initializes a new instance of the ForeignKeyConstraint class with the specified name, parent and child DataColumn objects.

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

Public Sub New (
	constraintName As String,
	parentColumn As DataColumn,
	childColumn As DataColumn


Type: System.String

The name of the constraint.

Type: System.Data.DataColumn

The parent DataColumn in the constraint.

Type: System.Data.DataColumn

The child DataColumn in the constraint.

Exception Condition

One or both of the columns is null.


The columns have different data types.

-Or -

The tables don't belong to the same DataSet.

The following example creates a new ForeignKeyConstraint, sets some of its properties, and adds it to a DataTable object's ConstraintCollection.

' The next line goes into the Declarations section of the module:
   ' SuppliersProducts is a class derived from DataSet.
   Private suppliersProducts As SuppliersProducts

Private Sub CreateConstraint()
   ' Declare parent column and child column variables.
   Dim parentColumn As DataColumn
   Dim childColumn As DataColumn
   Dim fkeyConstraint As ForeignKeyConstraint

   ' Set parent and child column variables.
   parentColumn = _
   childColumn = _
   fkeyConstraint = New ForeignKeyConstraint( _
       "SupplierFKConstraint", parentColumn, childColumn)

   ' Set various properties of the constraint.
   With fkeyConstraint
      .DeleteRule = Rule.SetNull
      .UpdateRule = Rule.Cascade
      .AcceptRejectRule = AcceptRejectRule.Cascade
   End With

   ' Add the constraint, and set EnforceConstraints to true.
   suppliersProducts.EnforceConstraints = True
End Sub

.NET Framework
Available since 1.1
Return to top