Rule Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Indicates the action that occurs when a ForeignKeyConstraint is enforced.
public enum class Rule
public enum Rule
type Rule =
Public Enum Rule
- Inheritance
Fields
Name | Value | Description |
---|---|---|
None | 0 | No action taken on related rows. |
Cascade | 1 | Delete or update related rows. This is the default. |
SetNull | 2 | Set values in related rows to |
SetDefault | 3 | Set values in related rows to the value contained in the DefaultValue property. |
Examples
' 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 = suppliersProducts.Tables("Suppliers").Columns("SupplierID")
childColumn = suppliersProducts.Tables("Products").Columns("SupplierID")
fkeyConstraint = New ForeignKeyConstraint( _
"SupplierFKConstraint", parentColumn, childColumn)
' Set null values when a value is deleted.
fkeyConstraint.DeleteRule = Rule.SetNull
fkeyConstraint.UpdateRule = Rule.Cascade
fkeyConstraint.AcceptRejectRule = AcceptRejectRule.Cascade
' Add the constraint, and set EnforceConstraints to true.
suppliersProducts.Tables("Products").Constraints.Add(fkeyConstraint)
suppliersProducts.EnforceConstraints = True
End Sub
Remarks
The Rule values are set to the UpdateRule and the DeleteRule properties of a ForeignKeyConstraint object found in a DataTable object's ConstraintCollection.
The Rule values determine the action that occurs when a value in a column is either deleted or updated. Of the two, deleting a value is the more critical and demanding of attention when setting a rule.
In the case where a value is deleted, Cascade
specifies that all rows containing that value are also deleted. SetNull
specifies that values in all child columns are set to null values. SetDefault
specifies that all child columns be set to the default value for the column. None
specifies that no action will occur, but exceptions are generated.
In the case where a value is updated, Cascade
specifies that all child columns are likewise updated with the new value. SetNull
specifies that all child columns be set to null values. SetDefault
specifies that all child column values be set to the default value. None
specifies that no action be taken, but exceptions are generated.
Constraints on a DataSet are not enforced unless the EnforceConstraints property is true
.
When the AcceptChanges method is called, the AcceptRejectRule further determines what action occurs.