.NET Framework Class Library ForeignKeyConstraint Class Represents an action restriction enforced on a set of columns in a primary key/foreign key relationship when a value or row is either deleted or updated.

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

Syntax
Public Class ForeignKeyConstraint _
Inherits Constraint
public class ForeignKeyConstraint : Constraint
public ref class ForeignKeyConstraint : public Constraint
type ForeignKeyConstraint =
class
inherit Constraint
end
The ForeignKeyConstraint type exposes the following members.

Constructors
|
| Name | Description |
|---|
.gif) .gif) | ForeignKeyConstraint(DataColumn, DataColumn) | Initializes a new instance of the ForeignKeyConstraint class with the specified parent and child DataColumn objects. | .gif) .gif) | ForeignKeyConstraint(array<DataColumn>[]()[], array<DataColumn>[]()[]) | Initializes a new instance of the ForeignKeyConstraint class with the specified arrays of parent and child DataColumn objects. | .gif) .gif) | ForeignKeyConstraint(String, DataColumn, DataColumn) | Initializes a new instance of the ForeignKeyConstraint class with the specified name, parent and child DataColumn objects. | .gif) .gif) | ForeignKeyConstraint(String, array<DataColumn>[]()[], array<DataColumn>[]()[]) | Initializes a new instance of the ForeignKeyConstraint class with the specified name, and arrays of parent and child DataColumn objects. | .gif) .gif) | ForeignKeyConstraint(String, String, array<String>[]()[], array<String>[]()[], AcceptRejectRule, Rule, Rule) | This constructor is provided for design time support in the Visual Studio environment. ForeignKeyConstraint objects created by using this constructor must then be added to the collection via AddRange. Tables and columns with the specified names must exist at the time the method is called, or if BeginInit has been called prior to calling this constructor, the tables and columns with the specified names must exist at the time that EndInit is called. | .gif) .gif) | ForeignKeyConstraint(String, String, String, array<String>[]()[], array<String>[]()[], AcceptRejectRule, Rule, Rule) | This constructor is provided for design time support in the Visual Studio environment. ForeignKeyConstraint objects created by using this constructor must then be added to the collection via AddRange. Tables and columns with the specified names must exist at the time the method is called, or if BeginInit has been called prior to calling this constructor, the tables and columns with the specified names must exist at the time that EndInit is called. | Top

Properties

Methods

Remarks
A ForeignKeyConstraint restricts the action performed when a value in a column (or columns) is either deleted or updated. Such a constraint is intended to be used with primary key columns. In a parent/child relationship between two tables, deleting a value from the parent table can affect the child rows in one of the following ways. The child rows can also be deleted (a cascading action). The values in the child column (or columns) can be set to null values. The values in the child column (or columns) can be set to default values. An exception can be generated.
ForeignKeyConstraint objects are contained in the ConstraintCollection of a DataTable, which is accessed through the Constraints property. Constraints are not enforced unless the EnforceConstraints property is set to true. The AcceptRejectRule is enforced whenever a DataTable object's AcceptChanges method is invoked.

Examples
The following example creates a 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 = 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

Version Information
.NET FrameworkSupported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0 .NET Framework Client ProfileSupported in: 4, 3.5 SP1

Platforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role not supported), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety
This type is safe for multithreaded read operations. You must synchronize any write operations.

See Also
|
Biblioteca de clases de .NET Framework ForeignKeyConstraint (Clase) Representa la restricción de una acción impuesta a un conjunto de columnas en una relación entre clave principal y clave externa cuando se elimina o actualiza un valor o una fila.

Jerarquía de herencia
Espacio de nombres:
System.Data
Ensamblado:
System.Data (en System.Data.dll)

Sintaxis
Public Class ForeignKeyConstraint _
Inherits Constraint
public class ForeignKeyConstraint : Constraint
public ref class ForeignKeyConstraint : public Constraint
type ForeignKeyConstraint =
class
inherit Constraint
end
El tipo ForeignKeyConstraint expone los siguientes miembros.

Constructores
|
| Nombre | Descripción |
|---|
.gif) .gif) | ForeignKeyConstraint(DataColumn, DataColumn) | Inicializa una nueva instancia de la clase ForeignKeyConstraint con los objetos DataColumn primarios y secundarios especificados. | .gif) .gif) | ForeignKeyConstraint(array<DataColumn>[]()[], array<DataColumn>[]()[]) | Inicializa una nueva instancia de la clase ForeignKeyConstraint con las matrices especificadas de objetos DataColumn primarios y secundarios. | .gif) .gif) | ForeignKeyConstraint(String, DataColumn, DataColumn) | Inicializa una nueva instancia de la clase ForeignKeyConstraint con el nombre especificado para los objetos DataColumn primarios y secundarios. | .gif) .gif) | ForeignKeyConstraint(String, array<DataColumn>[]()[], array<DataColumn>[]()[]) | Inicializa una nueva instancia de la clase ForeignKeyConstraint con el nombre y matrices especificados de objetos DataColumn primarios y secundarios. | .gif) .gif) | ForeignKeyConstraint(String, String, array<String>[]()[], array<String>[]()[], AcceptRejectRule, Rule, Rule) | Este constructor proporciona compatibilidad en tiempo de diseño en el entorno de Visual Studio. Los objetos ForeignKeyConstraint que se creen utilizando este constructor deben agregarse a la colección mediante AddRange. Deben existir tablas o columnas con los nombres especificados en el momento de llamar al método, o bien si se ha llamado a BeginInit antes de llamar a este constructor, deben existir tablas o columnas con los nombres especificados en el momento de llamar a EndInit. | .gif) .gif) | ForeignKeyConstraint(String, String, String, array<String>[]()[], array<String>[]()[], AcceptRejectRule, Rule, Rule) | Este constructor proporciona compatibilidad en tiempo de diseño en el entorno de Visual Studio. Los objetos ForeignKeyConstraint que se creen utilizando este constructor deben agregarse a la colección mediante AddRange. Deben existir tablas o columnas con los nombres especificados en el momento de llamar al método, o bien si se ha llamado a BeginInit antes de llamar a este constructor, deben existir tablas o columnas con los nombres especificados en el momento de llamar a EndInit. | Arriba

Propiedades

Métodos

Comentarios
ForeignKeyConstraint restringe la acción realizada cuando se elimina o actualiza un valor de columnas. Este tipo de restricción está pensado para utilizarlo con columnas de clave principal. En una relación primaria-secundaria entre dos tablas, la eliminación de un valor de la tabla primaria puede afectar las filas secundarias de una de las formas siguientes. También se pueden eliminar las filas secundarias (acción en cascada). Los valores de las columnas secundarias se pueden establecen en nulos. Los valores de las columnas secundarias se pueden establecer en predeterminados. Se puede generar una excepción.
Los objetos ForeignKeyConstraint están incluidos en el ConstraintCollection de un DataTable, al que se obtiene acceso mediante la propiedad Constraints. Las restricciones no se fuerzan a menos que la propiedad EnforceConstraints esté establecida en true. AcceptRejectRule se fuerza siempre que se invoca el método AcceptChanges de un objeto DataTable.

Ejemplos
En el ejemplo siguiente se crea un ForeignKeyConstraint, se establecen algunas de sus propiedades y se agrega a un ConstraintCollection de un objeto DataTable.
' 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

Información de versión
.NET FrameworkCompatible con: 4, 3.5, 3.0, 2.0, 1.1, 1.0 .NET Framework Client ProfileCompatible con: 4, 3.5 SP1

Plataformas
Windows 7, Windows Vista SP1 o posterior, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (no se admite Server Core), Windows Server 2008 R2 (se admite Server Core con SP1 o posterior), Windows Server 2003 SP2
.NET Framework no admite todas las versiones de todas las plataformas. Para obtener una lista de las versiones compatibles, vea Requisitos de sistema de .NET Framework.

Seguridad para subprocesos
Este tipo es seguro para operaciones de lectura multiproceso. Debe sincronizar cualquier operación de escritura.

Vea también
|