Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Equals Method
Collapse the table of content
Expand the table of content

ForeignKeyConstraint.Equals Method

Gets a value indicating whether the current ForeignKeyConstraint is identical to the specified object.

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

public override bool Equals(
	Object key
)

Parameters

key
Type: System.Object

The object to which this ForeignKeyConstraint is compared. Two ForeignKeyConstraint are equal if they constrain the same columns.

Return Value

Type: System.Boolean
true, if the objects are identical; otherwise, false.

The following example creates a new ForeignKeyConstraint and checks it against other collection members with the Equals method before adding it to a ConstraintCollection.

private void CreateConstraint(DataSet dataSet)
{
   // Create the ForignKeyConstraint with two DataColumn objects.
   DataColumn parentCol = dataSet.Tables["Customers"].Columns["id"];
   DataColumn childCol = dataSet.Tables["Orders"].Columns["OrderID"];
   ForeignKeyConstraint fkeyConstraint =
      new ForeignKeyConstraint("fkConstraint", parentCol, childCol);

   // Test against existing members using the Equals method. 
   foreach(ForeignKeyConstraint testConstraint in 
       dataSet.Tables["Orders"].Constraints)
   {
      if(fkeyConstraint.Equals(testConstraint)){
         Console.WriteLine("Identical ForeignKeyConstraint!");
          // Insert code to delete the duplicate object,  
          // or stop the procedure.
      }
   }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show:
© 2015 Microsoft