TechNet
Export (0) Print
Expand All

ForeignKeyCollection Class

 

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

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


[DefaultMemberAttribute("Item")]
public sealed class ForeignKeyCollection : SimpleObjectCollectionBase

NameDescription
System_CAPS_pubpropertyCount

Gets the number of objects in the referenced collection.(Inherited from SmoCollectionBase.)

System_CAPS_pubpropertyIsSynchronized

Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe.(Inherited from SmoCollectionBase.)

System_CAPS_pubpropertyItem[Int32]

Gets a ForeignKey object in the collection by index number.

System_CAPS_pubpropertyItem[String]

Gets a ForeignKey object in the collection by name.

System_CAPS_pubpropertyParent

Gets the Table object that is the parent of the ForeignKeyCollection object.

System_CAPS_pubpropertySyncRoot

Gets an object that can be used to synchronize access to the collection.(Inherited from SmoCollectionBase.)

NameDescription
System_CAPS_pubmethodAdd(ForeignKey)

Adds a ForeignKey object to the foreign key collection.

System_CAPS_protmethodAddExisting(SqlSmoObject)

Adds an object to the collection.(Inherited from AbstractCollectionBase.)

System_CAPS_pubmethodContains(String)

Verifies whether the specified object exists in the collection.(Inherited from SimpleObjectCollectionBase.)

System_CAPS_pubmethodCopyTo(ForeignKey[], Int32)

Copies the collection objects to a one-dimensional array beginning at the index value specified.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodItemById(Int32)

Extracts a member from the ForeignKeyCollection collection using a system-defined, unique identifier.

System_CAPS_pubmethodRefresh()

Refreshes the referenced collection.(Inherited from SmoCollectionBase.)

System_CAPS_pubmethodRefresh(Boolean)

Refreshes the referenced collection with the option to refresh child objects of the referenced collection.(Inherited from SmoCollectionBase.)

System_CAPS_pubmethodRemove(ForeignKey)

Removes a ForeignKey object from the foreign key collection.

System_CAPS_pubmethodRemove(String)

Removes a ForeignKey object from the foreign key collection.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_protfieldinitialized

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

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

Copies the elements from an instance to an array beginning at the index indicated.(Inherited from SmoCollectionBase.)

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.

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.

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

Return to top
Show:
© 2016 Microsoft