NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

ForeignKeyConstraint Constructor (String, DataColumn, DataColumn)

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

[Visual Basic]
Overloads Public Sub New( _
   ByVal constraintName As String, _
   ByVal parentColumn As DataColumn, _
   ByVal childColumn As DataColumn _
)
[C#]
public ForeignKeyConstraint(
   string constraintName,
   DataColumn parentColumn,
   DataColumn childColumn
);
[C++]
public: ForeignKeyConstraint(
   String* constraintName,
   DataColumn* parentColumn,
   DataColumn* childColumn
);
[JScript]
public function ForeignKeyConstraint(
   constraintName : String,
   parentColumn : DataColumn,
   childColumn : DataColumn
);

Parameters

constraintName
[To be supplied.]
parentColumn
The parent DataColumn in the constraint.
childColumn
The child DataColumn in the constraint.

Exceptions

Exception Type Condition
ArgumentNullException One or both of the columns is a null reference (in Visual Basic Nothing).
InvalidConstraintException The columns have different data types.

-Or-

The tables don't belong to the same DataSet.

Example [Visual Basic]

[Visual Basic]

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


Private Sub CreateConstraint()
   ' Declare parent column and child column variables.
   Dim pCol As DataColumn
   Dim cCol As DataColumn
   Dim myFKC As ForeignKeyConstraint
   ' Set parent and child column variables.
   pCol = MyDataSet.Tables("Suppliers").Columns("SupplierID")
   cCol = MyDataSet.Tables("Products").Columns("SupplieriD")
   myFKC = New ForeignKeyConstraint("SuppierFKConstraint", pCol, cCol)
   ' Set various properties of the constraint.
   With myFKC
      .DeleteRule = Rule.SetNull
      .UpdateRule = Rule.Cascade
      .AcceptRejectRule = AcceptRejectRule.Cascade
   End With
   ' Add the constraint, and set EnforceConstraints to true.
   myDataSet.Tables("Suppliers").Constraints.Add myFKC
   myDataSet.EnforceConstraints = True
End Sub

See Also

ForeignKeyConstraint Class | ForeignKeyConstraint Members | System.Data Namespace | ForeignKeyConstraint Constructor Overload List