ForeignKeyCollection Class

The ForeignKeyCollection class represents a collection of ForeignKey objects that represent all the foreign keys defined on the parent object.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
    Microsoft.SqlServer.Management.Smo.SmoCollectionBase
      Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
        Microsoft.SqlServer.Management.Smo.SimpleObjectCollectionBase
          Microsoft.SqlServer.Management.Smo.ForeignKeyCollection

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class ForeignKeyCollection _
    Inherits SimpleObjectCollectionBase
'Usage
Dim instance As ForeignKeyCollection
public sealed class ForeignKeyCollection : SimpleObjectCollectionBase
public ref class ForeignKeyCollection sealed : public SimpleObjectCollectionBase
[<SealedAttribute>]
type ForeignKeyCollection =  
    class 
        inherit SimpleObjectCollectionBase 
    end
public final class ForeignKeyCollection extends SimpleObjectCollectionBase

The ForeignKeyCollection type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.)
Public property IsSynchronized Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.)
Public property Item[Int32] Gets a ForeignKey object in the collection by index number.
Public property Item[String] Gets a ForeignKey object in the collection by name.
Public property Parent Gets the Table object that is the parent of the ForeignKeyCollection object.
Public property SyncRoot Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)

Top

Methods

  Name Description
Public method Add Adds a ForeignKey object to the foreign key collection.
Protected method AddExisting Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Public method Contains Verifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.)
Public method CopyTo Copies the collection objects to a one-dimensional array beginning at the index value specified.
Public method Equals (Inherited from Object.)
Public method GetEnumerator Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method ItemById Extracts a member from the ForeignKeyCollection collection using a system-defined, unique identifier.
Public method Refresh() Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
Public method Refresh(Boolean) Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
Public method Remove(String) Removes a ForeignKey object from the foreign key collection.
Public method Remove(ForeignKey) Removes a ForeignKey object from the foreign key collection.
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
Protected field initialized This value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection.CopyTo Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)

Top

Remarks

A ForeignKeyCollection object can be used to gain access to a set of foreign keys. You can use the Item property to return a specific ForeignKey object.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Using Collections

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace