CollectionItem Class

 

The CollectionItem class creates an instance of a collection item.

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

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

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

NameDescription
System_CAPS_pubmethodCollectionItem(CollectionSet, String)

Creates an instance of a collection item given the collection set name and an item name.

NameDescription
System_CAPS_protpropertyAbstractIdentityKey

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubpropertyCollectionFrequency

Gets or sets the collection frequency for this item if the collection set is running in CollectionMode = "continuous".

System_CAPS_pubpropertyId

Gets the collection item Id.

System_CAPS_pubpropertyIdentityKey

Gets the identity key for the collection item.

System_CAPS_pubpropertyMetadata

Returns metadata about the instance and its domain.(Inherited from SfcInstance.)

System_CAPS_pubpropertyName

Gets or sets the collection item name.

System_CAPS_pubpropertyParameters

Gets or sets collection item parameters.

System_CAPS_pubpropertyParent

Gets or sets the parent object in the object model hierarchy.

System_CAPS_pubpropertyProperties

Returns a collection instance properties.(Inherited from SfcInstance.)

System_CAPS_protpropertyState

Returns the state of the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubpropertyTypeName

Gets or sets the name of the collector type that the collection item implements.

System_CAPS_pubpropertyUrn

Returns the uniform resource name of the SfcInstance object.(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubmethodAlter()

Alters a collection item by applying the changes to the configuration store.

System_CAPS_protmethodCreateIdentityKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodDiscover(ISfcDependencyDiscoveryObjectSink)

This method is for internal use only.(Overrides SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodGetChildCollection(String)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetDomain()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetObjectFactory()

Instantiates an instance of the constructor used for collection items.

System_CAPS_pubmethodGetPropertySet()

Returns the set of properties for the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetTypeMetadataImpl()

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.)

System_CAPS_protmethodInitializeUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodMarkForDrop(Boolean)

This method marks a collection item for dropping if the collection item has been changed.

System_CAPS_protmethodOnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)

Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)

System_CAPS_protmethodOnPropertyValueChanges(PropertyChangedEventArgs)

Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)

System_CAPS_pubmethodRefresh()

Refreshes the object's properties by reading them from the server.(Inherited from SfcInstance.)

System_CAPS_pubmethodRename(String)

Renames a collection item.

System_CAPS_protmethodResetKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodSerialize(XmlWriter)

Serializes the instance to XML.(Inherited from SfcInstance.)

System_CAPS_pubmethodToString()

Returns a string representation of the instance Urn.(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubeventPropertyChanged

Occurs when a property value changes.(Inherited from SfcInstance.)

System_CAPS_pubeventPropertyMetadataChanged

Occurs when the metadata for a property has changed.(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcAlterable.ScriptAlter()

This method is for internal use only.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcRenamable.Rename(SfcKey)

This method is for internal use only.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcRenamable.ScriptRename(SfcKey)

This method is for internal use only.

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

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: