Delen via


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 Do not reference this member directly in your code. It supports the SQL Server infrastructure. (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 Returns metadata about the instance and its domain. (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 Returns a collection instance properties. (Inherited from SfcInstance.)
Protected property State Returns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public property TypeName Gets or sets the name of the collector type that the collection item implements.
Public property Urn Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)

Top

Methods

  Name Description
Public method Alter Alters a collection item by applying the changes to the configuration store.
Protected method CreateIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Discover This method is for internal use only. (Overrides SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).)
Public method Equals (Inherited from Object.)
Protected method GetChildCollection Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetDomain Do not reference this member directly in your code. It supports the SQL Server infrastructure. (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 Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method GetTypeMetadataImpl Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method InitializeUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method MarkForDrop This method marks a collection item for dropping if the collection item has been changed.
Protected method OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Public method Refresh Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Public method Rename Renames a collection item.
Protected method ResetKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Serialize Serializes the instance to XML. (Inherited from SfcInstance.)
Public method ToString Returns a string representation of the instance Urn. (Inherited from SfcInstance.)

Top

Events

  Name Description
Public event PropertyChanged CLS-compliant event for property changes. (Inherited from SfcInstance.)
Public event PropertyMetadataChanged CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ISfcAlterable.ScriptAlter This method is for internal use only.
Explicit interface implemetationPrivate method ISfcRenamable.Rename 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.

See Also

Reference

Microsoft.SqlServer.Management.Collector Namespace