• Article

CollectionItem Class

The CollectionItem class creates an instance of a collection item.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.Collector.CollectionItem

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

Syntax

'Declaration
Public NotInheritable Class CollectionItem _
    Inherits SfcInstance _
    Implements ISfcAlterable, IAlterable, ISfcRenamable, IRenamable,  _
    IMarkForDrop
'Usage
Dim instance As CollectionItem

public sealed class CollectionItem : SfcInstance, 
    ISfcAlterable, IAlterable, ISfcRenamable, IRenamable, IMarkForDrop

public ref class CollectionItem sealed : public SfcInstance, 
    ISfcAlterable, IAlterable, ISfcRenamable, IRenamable, IMarkForDrop

[<SealedAttribute>]
type CollectionItem =  
    class
        inherit SfcInstance
        interface ISfcAlterable
        interface IAlterable
        interface ISfcRenamable
        interface IRenamable
        interface IMarkForDrop
    end

public final class CollectionItem extends SfcInstance implements ISfcAlterable, IAlterable, ISfcRenamable, IRenamable, IMarkForDrop

The CollectionItem type exposes the following members.

Constructors

  Name Description
Public method CollectionItem Creates an instance of a collection item given the collection set name and an item name.

Top

Properties

  Name Description
Protected property AbstractIdentityKey (Inherited from SfcInstance.)
Public property CollectionFrequency Gets or sets the collection frequency for this item if the collection set is running in CollectionMode = "continuous".
Public property Id Gets the collection item Id.
Public property IdentityKey Gets the identity key for the collection item.
Public property Metadata (Inherited from SfcInstance.)
Public property Name Gets or sets the collection item name.
Public property Parameters Gets or sets collection item parameters.
Public property Parent Gets or sets the parent object in the object model hierarchy.
Public property Properties (Inherited from SfcInstance.)
Protected property PropertyStorageProvider (Inherited from SfcInstance.)
Protected property State (Inherited from SfcInstance.)
Public property TypeName Gets or sets the name of the collector type that the collection item implements.
Public property Urn (Inherited from SfcInstance.)

Top

Methods

  Name Description
Public method Alter Alters a collection item by applying the changes to the configuration store.
Protected method AlterImpl (Inherited from SfcInstance.)
Protected method CheckObjectCreated (Inherited from SfcInstance.)
Protected method CheckObjectState (Inherited from SfcInstance.)
Protected method CreateIdentityKey (Inherited from SfcInstance.)
Protected method CreateImpl (Inherited from SfcInstance.)
Public method Discover This method is for internal use only. (Overrides SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).)
Protected method DropImpl (Inherited from SfcInstance.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetChildCollection (Inherited from SfcInstance.)
Public method GetDomain (Inherited from SfcInstance.)
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetObjectFactory Instantiates an instance of the constructor used for collection items.
Public method GetPropertySet (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method GetTypeMetadataImpl (Inherited from SfcInstance.)
Protected method InitializeUIPropertyState (Inherited from SfcInstance.)
Public method MarkForDrop This method marks a collection item for dropping if the collection item has been changed.
Protected method MarkForDropImpl (Inherited from SfcInstance.)
Protected method MarkRootAsConnected (Inherited from SfcInstance.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method MoveImpl (Inherited from SfcInstance.)
Protected method OnPropertyMetadataChanges (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges (Inherited from SfcInstance.)
Protected method PostAlter (Inherited from SfcInstance.)
Protected method PostCreate (Inherited from SfcInstance.)
Protected method PostDrop (Inherited from SfcInstance.)
Protected method PostMove (Inherited from SfcInstance.)
Protected method PostRename (Inherited from SfcInstance.)
Public method Refresh (Inherited from SfcInstance.)
Public method Rename Renames a collection item.
Protected method RenameImpl (Inherited from SfcInstance.)
Protected method ResetKey (Inherited from SfcInstance.)
Public method Serialize (Inherited from SfcInstance.)
Public method ToString (Inherited from SfcInstance.)
Protected method UpdateUIPropertyState (Inherited from SfcInstance.)
Protected method Validate (Inherited from SfcInstance.)

Top

Events

  Name Description
Protected event propertyChanged (Inherited from SfcInstance.)
Public event PropertyChanged (Inherited from SfcInstance.)
Protected event propertyMetadataChanged (Inherited from SfcInstance.)
Public event PropertyMetadataChanged (Inherited from SfcInstance.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ISfcRenamable.Rename This method is for internal use only.
Explicit interface implemetationPrivate method ISfcAlterable.ScriptAlter This method is for internal use only.
Explicit interface implemetationPrivate method ISfcRenamable.ScriptRename This method is for internal use only.

Top

Remarks

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

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.