ForeignKeyColumnCollection ForeignKeyColumnCollection ForeignKeyColumnCollection Class

Definition

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

public ref class ForeignKeyColumnCollection sealed : Microsoft::SqlServer::Management::Smo::ParameterCollectionBase
public sealed class ForeignKeyColumnCollection : Microsoft.SqlServer.Management.Smo.ParameterCollectionBase
Public NotInheritable Class ForeignKeyColumnCollection
Inherits ParameterCollectionBase
Inheritance

Examples

Using Collections

Remarks

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

Properties

Count Count Count

Gets the number of objects in the referenced collection.

(Inherited from SmoCollectionBase)
IsSynchronized IsSynchronized IsSynchronized

Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe.

(Inherited from SmoCollectionBase)
Item[Int32] Item[Int32] Item[Int32]

Gets a ForeignKeyColumn object in the collection by index number.

Item[String] Item[String] Item[String]

Gets a ForeignKeyColumn object in the collection by name.

Parent Parent Parent

Gets the ForeignKey object that is the parent of the ForeignKeyColumnCollection object.

SyncRoot SyncRoot SyncRoot

Gets an object that can be used to synchronize access to the collection.

(Inherited from SmoCollectionBase)

Methods

Add(ForeignKeyColumn) Add(ForeignKeyColumn) Add(ForeignKeyColumn)

Adds a ForeignKeyColumn object to the foreign key column collection.

Add(ForeignKeyColumn, Int32) Add(ForeignKeyColumn, Int32) Add(ForeignKeyColumn, Int32)

Adds a ForeignKeyColumn object at a specified index position in the foreign key column collection.

Add(ForeignKeyColumn, String) Add(ForeignKeyColumn, String) Add(ForeignKeyColumn, String)

Adds a ForeignKeyColumn object to the position after a specified, existing ForeignKeyColumn object in the foreign key column collection.

AddExisting(SqlSmoObject) AddExisting(SqlSmoObject) AddExisting(SqlSmoObject)

Adds an object to the collection.

(Inherited from AbstractCollectionBase)
AddImpl(SqlSmoObject, Int32) AddImpl(SqlSmoObject, Int32) AddImpl(SqlSmoObject, Int32)

Adds an object or member to this collection at the specified index.

(Inherited from ArrayListCollectionBase)
Contains(String) Contains(String) Contains(String)

Validates whether the parameter collection contains a member with a name equal to the specified string.

(Inherited from ParameterCollectionBase)
CopyTo(ForeignKeyColumn[], Int32) CopyTo(ForeignKeyColumn[], Int32) CopyTo(ForeignKeyColumn[], Int32)

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

GetCollectionElementType() GetCollectionElementType() GetCollectionElementType()

Gets the Collection Element Type.

(Inherited from SmoCollectionBase)
GetEnumerator() GetEnumerator() GetEnumerator()

Returns an IEnumerator interface that allows you to iterate through the objects in the collection.

(Inherited from SmoCollectionBase)
GetItemById(Int32) GetItemById(Int32) GetItemById(Int32)

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

(Inherited from SmoCollectionBase)
GetItemById(Int32, String) GetItemById(Int32, String) GetItemById(Int32, String)

Extracts a member from the referenced collection using a system-defined, unique identifier and name.

(Inherited from SmoCollectionBase)
GetObjectByIndex(Int32) GetObjectByIndex(Int32) GetObjectByIndex(Int32)

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

(Inherited from SmoCollectionBase)
ImplAddExisting(SqlSmoObject) ImplAddExisting(SqlSmoObject) ImplAddExisting(SqlSmoObject)

Adds an object to a collection.

(Inherited from ParameterCollectionBase)
InitializeChildCollection() InitializeChildCollection() InitializeChildCollection()

Initializes the child collections of the referenced collection.

(Inherited from SmoCollectionBase)
InitializeChildCollection(Boolean) InitializeChildCollection(Boolean) InitializeChildCollection(Boolean)

Initializes the child collections of the referenced collection with the option to refresh the properties of the referenced collection.

(Inherited from SmoCollectionBase)
InitInnerCollection() InitInnerCollection() InitInnerCollection()

Initializes a collection.

(Inherited from ParameterCollectionBase)
ItemById(Int32) ItemById(Int32) ItemById(Int32)

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

Refresh() Refresh() Refresh()

Refreshes the referenced collection.

(Inherited from SmoCollectionBase)
Refresh(Boolean) Refresh(Boolean) Refresh(Boolean)

Refreshes the referenced collection with the option to refresh child objects of the referenced collection.

(Inherited from SmoCollectionBase)
Remove(ForeignKeyColumn) Remove(ForeignKeyColumn) Remove(ForeignKeyColumn)

Removes a ForeignKeyColumn object from the foreign key column collection.

Remove(String) Remove(String) Remove(String)

Removes a member from the collection with the specified name.

(Inherited from ParameterCollectionBase)
ValidateParentObject(SqlSmoObject) ValidateParentObject(SqlSmoObject) ValidateParentObject(SqlSmoObject)

Validates the parent object exists.

(Inherited from SmoCollectionBase)

Fields

initialized initialized initialized

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

(Inherited from AbstractCollectionBase)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32)

Copies the elements from an instance to an array beginning at the index indicated.

(Inherited from SmoCollectionBase)

Applies to