• Article

SynonymCollection Class

The SynonymCollection class represents a collection of Synonym objects that represent all the synonyms on the referenced database.

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

Syntax

'Declaration
Public NotInheritable Class SynonymCollection _
    Inherits SchemaCollectionBase
'Usage
Dim instance As SynonymCollection

public sealed class SynonymCollection : SchemaCollectionBase

public ref class SynonymCollection sealed : public SchemaCollectionBase

[<SealedAttribute>]
type SynonymCollection =  
    class
        inherit SchemaCollectionBase
    end

public final class SynonymCollection extends SchemaCollectionBase

The SynonymCollection 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 Synonym object in the collection by index number.
Public property Item[String] Gets a Synonym object in the collection by name.
Public property Item[String, String] Gets a Synonym object in the collection by name.
Public property Parent Gets the Database object that is the parent of the SynonymCollection 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 Add a synonym to the collection.
Protected method AddExisting Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Protected method AddImpl Adds the specified object to this collection (Inherited from SortedListCollectionBase.)
Public method Contains(String) Validates whether the parameter collection contains a member with a name equal to the specified string. (Inherited from SchemaCollectionBase.)
Public method Contains(String, String) Validates whether the parameter collection contains a member with a name equal to the specified string and with the specified schema. (Inherited from SchemaCollectionBase.)
Public method CopyTo Copies the collection of objects to a one-dimensional array starting at the specified index value.
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 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 SchemaCollectionBase.)
Public method ItemById Extracts a member from the SynonymCollection collection by 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 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 SynonymCollection object can be used to gain access to a set of synonyms. You can use the Item property to return a specific Synonym object.

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.