ConstraintCollection.Add Méthode

Définition

Espace de noms:

System.Data

Assembly:

System.Data.Common.dll

Ajoute un objet Constraint à la collection.

Surcharges

Add(Constraint)	Ajoute l'objet Constraint spécifié à la collection.
Add(String, DataColumn, Boolean)	Construit un nouveau UniqueConstraint portant le nom spécifié, DataColumn, ainsi qu'une valeur qui indique si la colonne est une clé primaire et l'ajoute à la collection.
Add(String, DataColumn, DataColumn)	Construit un nouveau ForeignKeyConstraint avec le nom, la colonne parente et la colonne enfant spécifiés, puis ajoute la contrainte à la collection.
Add(String, DataColumn[], Boolean)	Construit un nouveau UniqueConstraint avec le nom, le tableau d'objets DataColumn et la valeur spécifiés, qui indique s'il s'agit d'une colonne de clé primaire, et l'ajoute à la collection.
Add(String, DataColumn[], DataColumn[])	Construit un nouveau ForeignKeyConstraint avec les tableaux de colonnes enfants et parentes spécifiés, puis ajoute la contrainte à la collection.

Add(Constraint)

Source:

ConstraintCollection.cs

Ajoute l'objet Constraint spécifié à la collection.

public:
 void Add(System::Data::Constraint ^ constraint);

public void Add (System.Data.Constraint constraint);

member this.Add : System.Data.Constraint -> unit

Public Sub Add (constraint As Constraint)

Paramètres

constraint

Constraint

Constraint à ajouter.

Exceptions

ArgumentNullException

L’argument constraint a la valeur null.

ArgumentException

La contrainte appartient déjà à cette collection, ou à une autre collection.

DuplicateNameException

La collection possède déjà une contrainte portant le même nom. (La comparaison ne respecte pas la casse.)

Exemples

L’exemple suivant ajoute un UniqueConstraint au ConstraintCollection d’un DataTable.

private void AddConstraint(DataTable table)
{
    UniqueConstraint uniqueConstraint;
    // Assuming a column named "UniqueColumn" exists, and
    // its Unique property is true.
    uniqueConstraint = new UniqueConstraint(
        table.Columns["UniqueColumn"]);
    table.Constraints.Add(uniqueConstraint);
}

Private Sub AddConstraint(table As DataTable)
    Dim uniqueConstraint As UniqueConstraint
    ' Assuming a column named "UniqueColumn" exists, and 
    ' its Unique property is true.
    uniqueConstraint = _
       New UniqueConstraint(table.Columns("UniqueColumn"))
    table.Constraints.Add(uniqueConstraint)
End Sub

Remarques

Si la collection est modifiée avec succès en ajoutant ou en supprimant des contraintes, l’événement CollectionChanged se produit.

Voir aussi

• UniqueConstraint
• ForeignKeyConstraint

Add(String, DataColumn, Boolean)

Source:

ConstraintCollection.cs

Construit un nouveau UniqueConstraint portant le nom spécifié, DataColumn, ainsi qu'une valeur qui indique si la colonne est une clé primaire et l'ajoute à la collection.

public:
 System::Data::Constraint ^ Add(System::String ^ name, System::Data::DataColumn ^ column, bool primaryKey);

public System.Data.Constraint Add (string? name, System.Data.DataColumn column, bool primaryKey);

member this.Add : string * System.Data.DataColumn * bool -> System.Data.Constraint

Public Function Add (name As String, column As DataColumn, primaryKey As Boolean) As Constraint

Paramètres

name

String

Nom de l'objet UniqueConstraint.

column

DataColumn

DataColumn auquel la contrainte s'applique.

primaryKey

Boolean

Spécifie si la colonne doit être la clé primaire. Si true, la colonne sera une colonne de clé primaire.

Retours

Constraint

Nouveau UniqueConstraint.

Exceptions

ArgumentException

La contrainte appartient déjà à cette collection.

-Ou-

La contrainte appartient à une autre collection.

DuplicateNameException

La collection possède déjà une contrainte portant le nom spécifié. (La comparaison ne respecte pas la casse.)

Exemples

L’exemple suivant utilise la Add méthode pour créer et ajouter un nouveau UniqueConstraint à un ConstraintCollection.

private void AddUniqueConstraint(DataTable table){
   table.Constraints.Add("idConstraint", table.Columns["id"], true);
}

Private Sub AddUniqueConstraint(table As DataTable)
    table.Constraints.Add("idConstraint", table.Columns("id"), True)
End Sub

Remarques

L’événement CollectionChanged se produit si la contrainte est ajoutée avec succès.

Voir aussi

• UniqueConstraint

Add(String, DataColumn, DataColumn)

Source:

ConstraintCollection.cs

Construit un nouveau ForeignKeyConstraint avec le nom, la colonne parente et la colonne enfant spécifiés, puis ajoute la contrainte à la collection.

public:
 System::Data::Constraint ^ Add(System::String ^ name, System::Data::DataColumn ^ primaryKeyColumn, System::Data::DataColumn ^ foreignKeyColumn);

public System.Data.Constraint Add (string? name, System.Data.DataColumn primaryKeyColumn, System.Data.DataColumn foreignKeyColumn);

member this.Add : string * System.Data.DataColumn * System.Data.DataColumn -> System.Data.Constraint

Public Function Add (name As String, primaryKeyColumn As DataColumn, foreignKeyColumn As DataColumn) As Constraint

Paramètres

name

String

Nom de l'objet ForeignKeyConstraint.

primaryKeyColumn

DataColumn

Clé primaire (parente) DataColumn.

foreignKeyColumn

DataColumn

Clé étrangère (enfant) DataColumn.

Retours

Constraint

Nouveau ForeignKeyConstraint.

Exemples

L’exemple suivant ajoute un nouveau ForeignKeyConstraint au ConstraintCollection d’un 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());
    }
}

Private Sub AddForeignConstraint(dataSet As DataSet)
    Try
        Dim parentColumn As DataColumn = _
            dataSet.Tables("Suppliers").Columns("SupplierID")
        Dim childColumn As DataColumn = _
            dataSet.Tables("Products").Columns("SupplierID")
        dataSet.Tables("Products").Constraints.Add _
            ("ProductsSuppliers", parentColumn, childColumn)
        
    Catch ex As Exception
        ' In case the constraint already exists, 
        ' catch the collision here and respond.
        Console.WriteLine("Exception of type {0} occurred.", _
            ex.GetType().ToString())
    End Try
End Sub

Remarques

L’événement CollectionChanged se produit si la contrainte est ajoutée avec succès.

Add(String, DataColumn[], Boolean)

Source:

ConstraintCollection.cs

Construit un nouveau UniqueConstraint avec le nom, le tableau d'objets DataColumn et la valeur spécifiés, qui indique s'il s'agit d'une colonne de clé primaire, et l'ajoute à la collection.

public:
 System::Data::Constraint ^ Add(System::String ^ name, cli::array <System::Data::DataColumn ^> ^ columns, bool primaryKey);

public System.Data.Constraint Add (string? name, System.Data.DataColumn[] columns, bool primaryKey);

member this.Add : string * System.Data.DataColumn[] * bool -> System.Data.Constraint

Public Function Add (name As String, columns As DataColumn(), primaryKey As Boolean) As Constraint

Paramètres

name

String

Nom de l'objet UniqueConstraint.

columns

DataColumn[]

Tableau d'objets DataColumn auxquels s'applique la contrainte.

primaryKey

Boolean

Spécifie si la colonne doit être la clé primaire. Si true, la colonne sera une colonne de clé primaire.

Retours

Constraint

Nouveau UniqueConstraint.

Exceptions

ArgumentException

La contrainte appartient déjà à cette collection.

-Ou-

La contrainte appartient à une autre collection.

DuplicateNameException

La collection possède déjà une contrainte portant le nom spécifié. (La comparaison ne respecte pas la casse.)

Exemples

L’exemple suivant crée un tableau d’objets DataColumn qui sont utilisés pour en créer un UniqueConstraint dans un spécifique DataTable.

private void AddUniqueConstraint(DataTable table)
{
    DataColumn[] columns = new DataColumn[1];
    columns[0] = table.Columns["ID"];
    columns[1] = table.Columns["Name"];
    table.Constraints.Add("idNameConstraint", columns, true);
}

Private Sub AddUniqueConstraint(table As DataTable)
    Dim columns(1) As DataColumn
    columns(0) = table.Columns("ID")
    columns(1) = table.Columns("Name")
    table.Constraints.Add("idNameConstraint", columns, True)
End Sub

Remarques

L’événement CollectionChanged se produit si la contrainte est ajoutée avec succès.

Voir aussi

• UniqueConstraint

Add(String, DataColumn[], DataColumn[])

Source:

ConstraintCollection.cs

Construit un nouveau ForeignKeyConstraint avec les tableaux de colonnes enfants et parentes spécifiés, puis ajoute la contrainte à la collection.

public:
 System::Data::Constraint ^ Add(System::String ^ name, cli::array <System::Data::DataColumn ^> ^ primaryKeyColumns, cli::array <System::Data::DataColumn ^> ^ foreignKeyColumns);

public System.Data.Constraint Add (string? name, System.Data.DataColumn[] primaryKeyColumns, System.Data.DataColumn[] foreignKeyColumns);

member this.Add : string * System.Data.DataColumn[] * System.Data.DataColumn[] -> System.Data.Constraint

Public Function Add (name As String, primaryKeyColumns As DataColumn(), foreignKeyColumns As DataColumn()) As Constraint

Paramètres

name

String

Nom de l'objet ForeignKeyConstraint.

primaryKeyColumns

DataColumn[]

Tableau d'objets DataColumn qui sont les colonnes clés primaires ou parentes.

foreignKeyColumns

DataColumn[]

Tableau d'objets DataColumn qui sont les colonnes clés étrangères ou enfants.

Retours

Constraint

Nouveau ForeignKeyConstraint.

Exemples

L’exemple suivant crée deux tableaux d’objets DataColumn , puis crée deux ForeignKeyConstraint relations entre deux tables dans un jeu de données.

private void AddForeignConstraint(
    DataSet dataSet, DataTable table)
{
    try
    {
        DataColumn[] parentColumns = new DataColumn[2];
        DataColumn[] childColumns = new DataColumn[2];
        // Get the tables from the DataSet.
        DataTable customersTable = dataSet.Tables["Customers"];
        DataTable ordersTable = dataSet.Tables["Orders"];

        // Set Columns.
        parentColumns[0]=customersTable.Columns["id"];
        parentColumns[1]=customersTable.Columns["Name"];
        childColumns[0] = ordersTable.Columns["CustomerID"];
        childColumns[1] = ordersTable.Columns["CustomerName"];

        // Create ForeignKeyConstraint
        table.Constraints.Add("CustOrdersConstraint",
            parentColumns, childColumns);
    }
    catch(Exception ex)
    {
        // In case the constraint already exists,
        // catch the collision here and respond.
        Console.WriteLine("Exception of type {0} occurred.",
            ex.GetType());
    }
}

Private Sub AddForeignConstraint( _
ByVal dataSet As DataSet, ByVal table As DataTable)
    Try
        Dim parentColumns(1) As DataColumn
        Dim childColumns(1) As DataColumn
        ' Get the tables from the DataSet.
        Dim customersTable As DataTable = _
            dataSet.Tables("Customers")
        Dim ordersTable As DataTable = _
            dataSet.Tables("Orders")

        ' Set Columns.
        parentColumns(0) = customersTable.Columns("id")
        parentColumns(1) = customersTable.Columns("Name")
        childColumns(0) = ordersTable.Columns("CustomerID")
        childColumns(1) = ordersTable.Columns("CustomerName")

        ' Create ForeignKeyConstraint
        table.Constraints.Add("CustOrdersConstraint", _
            parentColumns, childColumns)

    Catch ex As Exception
        ' In case the constraint already exists, 
        ' catch the collision here and respond.
        Console.WriteLine("Exception of type {0} occurred.", _
            ex.GetType().ToString())
    End Try
End Sub

Remarques

L’événement CollectionChanged se produit si la contrainte est ajoutée avec succès.