IndexCollection IndexCollection IndexCollection Class

Definition

The IndexCollection class represents a collection of Index objects that represent all the indexes defined on the instance of SQL Server.

public ref class IndexCollection sealed : Microsoft::SqlServer::Management::Smo::SimpleObjectCollectionBase
public sealed class IndexCollection : Microsoft.SqlServer.Management.Smo.SimpleObjectCollectionBase
Public NotInheritable Class IndexCollection
Inherits SimpleObjectCollectionBase
Inheritance

Examples

Using Collections

Remarks

An IndexCollection object can be used to gain access to a set of indexes. You can use the Item[String] property to return a specific Index 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 an Index object in the collection by index number.

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

Gets an Index object in the collection by name.

Parent Parent Parent

Gets the SqlSmoObject object that is the parent of the IndexCollection object.

SyncRoot SyncRoot SyncRoot

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

(Inherited from SmoCollectionBase)

Methods

Add(Index) Add(Index) Add(Index)

Adds an Index object to the IndexCollection collection.

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

Adds an object to the collection.

(Inherited from AbstractCollectionBase)
AddImpl(SqlSmoObject) AddImpl(SqlSmoObject) AddImpl(SqlSmoObject)

Adds the specified object to this collection

(Inherited from SortedListCollectionBase)
Contains(String) Contains(String) Contains(String)

Verifies whether the specified object exists in the collection.

(Inherited from SimpleObjectCollectionBase)
CopyTo(Index[], Int32) CopyTo(Index[], Int32) CopyTo(Index[], 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 existing specified object to this collection

(Inherited from SortedListCollectionBase)
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 the collection.

(Inherited from SimpleObjectCollectionBase)
ItemById(Int32) ItemById(Int32) ItemById(Int32)

Extracts a member from the IndexCollection 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(Index) Remove(Index) Remove(Index)

Removes an Index object from the IndexCollection collection.

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

Removes an Index object from the IndexCollection collection.

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