Export (0) Print
Expand All

ForeignKeyColumnCollection Class

The ForeignKeyColumnCollection class represents a collection of ForeignKeyColumn objects that represent all the foreign key columns defined on the parent object.

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

public final class ForeignKeyColumnCollection extends ParameterCollectionBase

The ForeignKeyColumnCollection type exposes the following members.

  NameDescription
Public propertyCountGets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.)
Public propertyIsSynchronizedGets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.)
Public propertyItem(Int32)Gets a ForeignKeyColumn object in the collection by index number.
Public propertyItem(String)Gets a ForeignKeyColumn object in the collection by name.
Public propertyParentGets the ForeignKey object that is the parent of the ForeignKeyColumnCollection object.
Public propertySyncRootGets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)
Top

  NameDescription
Public methodAdd(ForeignKeyColumn)Adds a ForeignKeyColumn object to the foreign key column collection.
Public methodAdd(ForeignKeyColumn, Int32)Adds a ForeignKeyColumn object at a specified index position in the foreign key column collection.
Public methodAdd(ForeignKeyColumn, String)Adds a ForeignKeyColumn object to the position after a specified, existing ForeignKeyColumn object in the foreign key column collection.
Protected methodAddExistingAdds an object to the collection. (Inherited from AbstractCollectionBase.)
Public methodContainsValidates whether the parameter collection contains a member with a name equal to the specified string. (Inherited from ParameterCollectionBase.)
Public methodCopyToCopies the collection objects to a one-dimensional array beginning at the index value specified.
Public methodEquals (Inherited from Object.)
Public methodGetEnumeratorReturns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodItemByIdExtracts a member from the ForeignKeyColumnCollection collection using a system-defined, unique identifier.
Public methodRefresh()Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
Public methodRefresh(Boolean)Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
Public methodRemove(String)Removes a member from the collection with the specified name. (Inherited from ParameterCollectionBase.)
Public methodRemove(ForeignKeyColumn)Removes a ForeignKeyColumn object from the foreign key column collection.
Public methodToString (Inherited from Object.)
Top

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

  NameDescription
Explicit interface implemetationPrivate methodICollectionCopyToCopies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)
Top

A ForeignKeyColumnCollection object can be used to gain access to a set of foreign key columns. You can use the Item property to return a specific ForeignKeyColumn 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft