Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

CollectionItem Class

The CollectionItem class creates an instance of a collection item.

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)
public sealed class CollectionItem : SfcInstance, 
	ISfcAlterable, IAlterable, ISfcRenamable, IRenamable, IMarkForDrop

The CollectionItem type exposes the following members.

  NameDescription
Public methodCollectionItemCreates an instance of a collection item given the collection set name and an item name.
Top
  NameDescription
Protected propertyAbstractIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public propertyCollectionFrequencyGets or sets the collection frequency for this item if the collection set is running in CollectionMode = "continuous".
Public propertyIdGets the collection item Id.
Public propertyIdentityKeyGets the identity key for the collection item.
Public propertyMetadataReturns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public propertyNameGets or sets the collection item name.
Public propertyParametersGets or sets collection item parameters.
Public propertyParentGets or sets the parent object in the object model hierarchy.
Public propertyPropertiesReturns a collection instance properties. (Inherited from SfcInstance.)
Protected propertyStateReturns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public propertyTypeNameGets or sets the name of the collector type that the collection item implements.
Public propertyUrnReturns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)
Top
  NameDescription
Public methodAlterAlters a collection item by applying the changes to the configuration store.
Protected methodCreateIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodDiscoverThis method is for internal use only. (Overrides SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).)
Public methodEquals (Inherited from Object.)
Protected methodGetChildCollectionDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetDomainDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetHashCode (Inherited from Object.)
Public methodStatic memberGetObjectFactoryInstantiates an instance of the constructor used for collection items.
Public methodGetPropertySetReturns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public methodGetType (Inherited from Object.)
Protected methodGetTypeMetadataImplIndicates 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 methodInitializeUIPropertyStateDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodMarkForDropThis method marks a collection item for dropping if the collection item has been changed.
Protected methodOnPropertyMetadataChangesInvoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected methodOnPropertyValueChangesInvoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Public methodRefreshRefreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Public methodRenameRenames a collection item.
Protected methodResetKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodSerializeSerializes the instance to XML. (Inherited from SfcInstance.)
Public methodToStringReturns a string representation of the instance Urn. (Inherited from SfcInstance.)
Top
  NameDescription
Public eventPropertyChangedCLS-compliant event for property changes. (Inherited from SfcInstance.)
Public eventPropertyMetadataChangedCLS-compliant event for property metadata changes. (Inherited from SfcInstance.)
Top
  NameDescription
Explicit interface implemetationPrivate methodISfcAlterable.ScriptAlterThis method is for internal use only.
Explicit interface implemetationPrivate methodISfcRenamable.RenameThis method is for internal use only.
Explicit interface implemetationPrivate methodISfcRenamable.ScriptRenameThis method is for internal use only.
Top

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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.