Share via

  • Article

SfcCollatedDictionaryCollection<T, K, ParentT> Class

Represents a collection base class that uses an internal collection that is a SortedDictionary<K, T> object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcCollection<T, K, ParentT>
    Microsoft.SqlServer.Management.Sdk.Sfc.SfcCollatedDictionaryCollection<T, K, ParentT>
      More...

Namespace:  Microsoft.SqlServer.Management.Sdk.Sfc
Assembly:  Microsoft.SqlServer.Management.Sdk.Sfc (in Microsoft.SqlServer.Management.Sdk.Sfc.dll)

Syntax

'Declaration
Public MustInherit Class SfcCollatedDictionaryCollection(Of T As SfcInstance, K As SfcKey, ParentT As SfcInstance) _
    Inherits SfcCollection(Of T, K, ParentT) _
    Implements IComparer(Of K), IEnumerable
'Usage
Dim instance As SfcCollatedDictionaryCollection(Of T, K, ParentT)

public abstract class SfcCollatedDictionaryCollection<T, K, ParentT> : SfcCollection<T, K, ParentT>, 
    IComparer<K>, IEnumerable
where T : SfcInstance
where K : SfcKey
where ParentT : SfcInstance

generic<typename T, typename K, typename ParentT>
where T : SfcInstance
where K : SfcKey
where ParentT : SfcInstance
public ref class SfcCollatedDictionaryCollection abstract : public SfcCollection<T, K, ParentT>, 
    IComparer<K>, IEnumerable

[<AbstractClassAttribute>]
type SfcCollatedDictionaryCollection<'T, 'K, 'ParentT when 'T : SfcInstance when 'K : SfcKey when 'ParentT : SfcInstance> =  
    class
        inherit SfcCollection<'T, 'K, 'ParentT>
        interface IComparer<'K>
        interface IEnumerable
    end

JScript does not support generic types and methods.

Type Parameters

  • T
    The type of the items in the collection, constrained to SfcInstance.
  • K
    The type of the key, constrained to SfcKey.
  • ParentT
    The type of the parent object, constrained to SfcInstance.

The SfcCollatedDictionaryCollection<T, K, ParentT> type exposes the following members.

Constructors

  Name Description
Protected method SfcCollatedDictionaryCollection<T, K, ParentT>(ParentT) Initializes a new instance of the SfcCollatedDictionaryCollection<T, K, ParentT> class using the specified parent. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Protected method SfcCollatedDictionaryCollection<T, K, ParentT>(ParentT, IComparer<String>) Do not reference this member directly in your code. It supports the SQL Server infrastructure. Initializes a new instance of the SfcCollatedDictionaryCollection<T, K, ParentT> class using the specified parent and IComparer<T> object.

Top

Properties

  Name Description
Public property Ascending Gets or sets a value indicating whether to sort in ascending order. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Public property Count Gets the number of elements contained in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.Count.)
Protected property CultureInfo Gets or sets the CultureInfo object that is used by the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Protected property IgnoreCase Gets or sets a value indicating whether the collection is case-sensitive. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Protected property Initialized Gets a value indicating whether the collection has been initialized. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public property IsReadOnly Gets a value indicating whether the collection is read-only. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.IsReadOnly.)
Public property IsSynchronized Gets or sets a value indicating whether access to the collection is synchronized (thread safe). Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public property Item Gets the item specified by the key. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Protected property Parent Gets or sets the type of the parent object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public property SyncRoot Gets or sets an object that can be used to synchronize access to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)

Top

Methods

  Name Description
Public method Add Adds an item to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.Add(T).)
Protected method AddShadow Adds the specified object to the shadow collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.AddShadow(T).)
Public method Clear Removes all items from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.Clear().)
Public method Contains(K) Determines whether the collection contains the specified key. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.Contains(T).)
Public method Contains(T) Determines whether the collection contains the specified object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.Contains(T).)
Public method CopyTo(array<T[], Int32) Copies the elements from the collection to the specified array, starting at the specified array index. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.CopyTo(array<T[], Int32).)
Public method CopyTo(Array, Int32) Copies the elements from the collection to the specified array, starting at the specified array index. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Protected method CreateAndInitializeChildObject Creates a child object and adds it to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Protected method EnsureCollectionInitialized Initialize the collection from the server. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method FinishMerge Swaps the new collection for the old collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.FinishMerge().)
Protected method GetCollectionElementNameImpl Gets the Uniform Resource Name (URN) suffix for elements in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Protected method GetElementFactoryImpl Returns the factory that is used to instantiate objects for the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public method GetEnumerator Returns an enumerator that can iterate through the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.GetEnumerator().)
Protected method GetExistingObjectByKey Uses the specified key to retrieve an existing object from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.GetExistingObjectByKey(K).)
Public method GetHashCode (Inherited from Object.)
Protected method GetObjectByKey Uses the specified key to retrieve an object from the collection. If a matching object is not found, the object is created, and added to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.GetObjectByKey(K).)
Public method GetType (Inherited from Object.)
Protected method ImplAddExisting Adds an item to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.ImplAddExisting(T).)
Protected method ImplRemoveExisting Removes the specified object from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.ImplRemoveExisting(T).)
Protected method InitInnerCollection Creates an empty internal collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.InitInnerCollection().)
Protected method MemberwiseClone (Inherited from Object.)
Protected method PrepareMerge Prepares to merge fresh query results into the existing collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.PrepareMerge().)
Public method Refresh() Refreshes the collection by creating new and merging existing objects and properties in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public method Refresh(Boolean) Refreshes the collection by creating new and merging existing objects and properties in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public method Remove Removes the specified object from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Overrides SfcCollection<T, K, ParentT>.Remove(T).)
Protected method RemoveInternal Marks the specified object for removal. The state of the object is set to ToBeDropped. The object will be removed when the parent is altered or dropped. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Protected method Rename Renames the specified object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Protected method ResetInnerCollection Resets the CultureInfo, IgnoreCase, and Ascending properties on the inner collection to honor the new settings. Call this method after any of the properties have changed. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IComparer<K>.Compare Do not reference this member directly in your code. It supports the SQL Server infrastructure. Compares two keys.
Explicit interface implemetationPrivate property IListSource.ContainsListCollection Gets a value indicating whether the collection is a collection of IList objects. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Gets an enumerator that can iterate the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method IListSource.GetList Returns an IList object that can be bound to a data source from an object that does not implement the IList interface. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.Add Adds the specified object to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.AddShadow Adds the specified object to the shadow collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate property ISfcCollection.Count Gets the number of items contained in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.EnsureInitialized Initializes the collection from the server. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.FinishMerge Swaps the new collection for the old collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.GetCollectionElementNameImpl Gets the URN suffix for elements in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.GetElementFactory Gets the factory that is used to instantiate objects for the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.GetExisting Uses the specified key to retrieve an existing item from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.GetObjectByKey Uses the specified key to retrieve an object from the collection. If a matching object is not found, the object is created, and added to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate property ISfcCollection.Initialized Gets or sets a value indicating whether the collection has been initialized. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate property ISfcCollection.Parent Gets the parent object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.PrepareMerge Prepares to merge fresh query results into the existing collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.Remove Removes the specified object from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.RemoveElement Removes the specified element from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.Rename Renames the specified object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)

Top

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.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcCollection<T, K, ParentT>
    Microsoft.SqlServer.Management.Sdk.Sfc.SfcCollatedDictionaryCollection<T, K, ParentT>
      Microsoft.SqlServer.Management.Dac.DacInstanceCollection
      Microsoft.SqlServer.Management.Dmf.PolicyCategoryCollection
      Microsoft.SqlServer.Management.Dmf.PolicyCollection
      Microsoft.SqlServer.Management.Dmf.TargetSetCollection
      Microsoft.SqlServer.Management.Dmf.TargetSetLevelCollection
      Microsoft.SqlServer.Management.RegisteredServers.RegisteredServerCollection
      Microsoft.SqlServer.Management.RegisteredServers.ServerGroupCollection
      Microsoft.SqlServer.Management.Utility.ComputerCollection
      Microsoft.SqlServer.Management.Utility.DeployedDacCollection
      Microsoft.SqlServer.Management.Utility.ManagedInstanceCollection
      Microsoft.SqlServer.Management.Utility.VolumeCollection