ColumnCollection Class

The ColumnCollection class represents a collection of Column objects that represent all the columns defined on a table.

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

Syntax

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

The ColumnCollection 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 Column object in the collection by index number.
Public property Item[String] Gets a Column object in the collection by name.
Public property Parent Gets the SqlSmoObject object that is the parent of the ColumnCollection 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(Column) Adds a Column object to the ColumnCollection collection.
Public method Add(Column, Int32) Adds a Column object to the ColumnCollection collection at a specified position.
Public method Add(Column, String) Adds a Column object to the ColumnCollection collection after a specified Column object currently in the ColumnCollection collection.
Protected method AddExisting Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Protected method AddImpl Adds an object or member to this collection at the specified index. (Inherited from ArrayListCollectionBase.)
Public method Contains Validates whether the parameter collection contains a member with a name equal to the specified string. (Inherited from ParameterCollectionBase.)
Public method CopyTo Copies the collection objects to a one-dimensional array beginning at the index value specified.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetCollectionElementType Gets the Collection Element Type. (Inherited from SmoCollectionBase.)
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.)
Protected method GetItemById(Int32) Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.)
Protected method GetItemById(Int32, String) Extracts a member from the referenced collection using a system-defined, unique identifier and name. (Inherited from SmoCollectionBase.)
Protected method GetObjectByIndex Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.)
Public method GetType (Inherited from Object.)
Protected method ImplAddExisting Adds an object to a collection. (Inherited from ParameterCollectionBase.)
Protected method InitializeChildCollection() Initializes the child collections of the referenced collection. (Inherited from SmoCollectionBase.)
Protected method InitializeChildCollection(Boolean) Initializes the child collections of the referenced collection with the option to refresh the properties of the referenced collection. (Inherited from SmoCollectionBase.)
Protected method InitInnerCollection Initializes a collection. (Inherited from ParameterCollectionBase.)
Public method ItemById Extracts a member from the ColumnCollection collection using a system-defined, unique identifier.
Protected method MemberwiseClone (Inherited from Object.)
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 member from the collection with the specified name. (Inherited from ParameterCollectionBase.)
Public method Remove(Column) Removes a Column object from the ColumnCollection collection.
Public method ToString (Inherited from Object.)
Protected method ValidateParentObject Validates the parent object exists. (Inherited from SmoCollectionBase.)

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 ColumnCollection object can be used to gain access to a set of columns. You can use the Item property to return a specific Column 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.

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.