• Article

PlanGuideCollection Members

Include Protected Members
Include Inherited Members

Collection of plan guide objects.

The PlanGuideCollection type exposes the following members.

Methods

  Name Description
Public method Add(PlanGuide) Adds a plan guide object to the collection.
Protected method AddExisting(SqlSmoObject) Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Protected method AddImpl(SqlSmoObject) Adds the specified object to this collection (Inherited from SortedListCollectionBase.)
Public method Contains(String) Verifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.)
Public method CopyTo(array<PlanGuide[], Int32) Copies all the items from a plan guide collection to a compatible one-dimensional array of objects, starting at the specified index in the target array.
Public method Equals(Object) (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(Int32) 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(SqlSmoObject) Adds an existing specified object to this collection (Inherited from SortedListCollectionBase.)
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 the collection. (Inherited from SimpleObjectCollectionBase.)
Public method ItemById(Int32) Returns a plan guide object as indicated by the ID property of that plan guide.
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 plan guide from a plan guide collection based on the PlanGuide Name property.
Public method Remove(PlanGuide) Removes a plan guide from a plan guide collection.
Public method ToString() (Inherited from Object.)
Protected method ValidateParentObject(SqlSmoObject) 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

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] Returns an item from a collection of plan guide objects that are identified by the integer ID index of the item.
Public property Item[String] Returns an Item from a collection of plan guide objects identified by the Name property of the item.
Public property Parent Returns a database object that represents the parent of the collection.
Public property SyncRoot Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection.CopyTo(Array, Int32) Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)

Top