CollectionItem CollectionItem CollectionItem Class

Definition

The CollectionItem class creates an instance of a collection item.

public ref class CollectionItem sealed : Microsoft::SqlServer::Management::Sdk::Sfc::SfcInstance, Microsoft::SqlServer::Management::Common::IAlterable, Microsoft::SqlServer::Management::Common::IMarkForDrop, Microsoft::SqlServer::Management::Common::IRenamable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcAlterable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcRenamable
public sealed class CollectionItem : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.IMarkForDrop, Microsoft.SqlServer.Management.Common.IRenamable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcRenamable
Public NotInheritable Class CollectionItem
Inherits SfcInstance
Implements IAlterable, IMarkForDrop, IRenamable, ISfcAlterable, ISfcRenamable
Inheritance
CollectionItemCollectionItemCollectionItem
Implements
Microsoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterable Microsoft.SqlServer.Management.Common.IMarkForDropMicrosoft.SqlServer.Management.Common.IMarkForDropMicrosoft.SqlServer.Management.Common.IMarkForDrop Microsoft.SqlServer.Management.Common.IRenamableMicrosoft.SqlServer.Management.Common.IRenamableMicrosoft.SqlServer.Management.Common.IRenamable ISfcAlterableISfcAlterableISfcAlterable ISfcRenamableISfcRenamableISfcRenamable

Remarks

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

Constructors

CollectionItem(CollectionSet, String) CollectionItem(CollectionSet, String) CollectionItem(CollectionSet, String)

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

Properties

AbstractIdentityKey AbstractIdentityKey AbstractIdentityKey

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CollectionFrequency CollectionFrequency CollectionFrequency

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

Id Id Id

Gets the collection item Id.

IdentityKey IdentityKey IdentityKey

Gets the identity key for the collection item.

Metadata Metadata Metadata

Returns metadata about the instance and its domain.

(Inherited from SfcInstance)
Name Name Name

Gets or sets the collection item name.

Parameters Parameters Parameters

Gets or sets collection item parameters.

Parent Parent Parent

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

Properties Properties Properties

Returns a collection instance properties.

(Inherited from SfcInstance)
PropertyStorageProvider PropertyStorageProvider PropertyStorageProvider

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
State State State

Returns the state of the SfcInstance object.

(Inherited from SfcInstance)
TypeName TypeName TypeName

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

Urn Urn Urn

Returns the uniform resource name of the SfcInstance object.

(Inherited from SfcInstance)

Methods

Alter() Alter() Alter()

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

AlterImpl() AlterImpl() AlterImpl()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CheckObjectCreated() CheckObjectCreated() CheckObjectCreated()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CheckObjectState() CheckObjectState() CheckObjectState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CreateIdentityKey() CreateIdentityKey() CreateIdentityKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CreateImpl() CreateImpl() CreateImpl()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink)

This method is for internal use only.

DropImpl() DropImpl() DropImpl()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
GetChildCollection(String) GetChildCollection(String) GetChildCollection(String)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
GetDomain() GetDomain() GetDomain()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
GetObjectFactory() GetObjectFactory() GetObjectFactory()

Instantiates an instance of the constructor used for collection items.

GetPropertySet() GetPropertySet() GetPropertySet()

Returns the set of properties for the SfcInstance object.

(Inherited from SfcInstance)
GetTypeMetadataImpl() GetTypeMetadataImpl() 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)
InitializeUIPropertyState() InitializeUIPropertyState() InitializeUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
MarkForDrop(Boolean) MarkForDrop(Boolean) MarkForDrop(Boolean)

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

MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean)

Returns a value that indicates the existing objects to be dropped. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
MarkRootAsConnected() MarkRootAsConnected() MarkRootAsConnected()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
MoveImpl(SfcInstance) MoveImpl(SfcInstance) MoveImpl(SfcInstance)

Indicates the new parent object to move in an instance. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)

Invoked whenever the effective value of any SfcInstance metadata is updated.

(Inherited from SfcInstance)
OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs)

Invoked whenever the effective value of any SfcInstance property is updated.

(Inherited from SfcInstance)
PostAlter(Object) PostAlter(Object) PostAlter(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostCreate(Object) PostCreate(Object) PostCreate(Object)

Indicates the default implementor that creates the execution result. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostDrop(Object) PostDrop(Object) PostDrop(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostMove(Object) PostMove(Object) PostMove(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostRename(Object) PostRename(Object) PostRename(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Refresh() Refresh() Refresh()

Refreshes the object's properties by reading them from the server.

(Inherited from SfcInstance)
Rename(String) Rename(String) Rename(String)

Renames a collection item.

RenameImpl(SfcKey) RenameImpl(SfcKey) RenameImpl(SfcKey)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
ResetKey() ResetKey() ResetKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Serialize(XmlWriter) Serialize(XmlWriter) Serialize(XmlWriter)

Serializes the instance to XML.

(Inherited from SfcInstance)
ToString() ToString() ToString()

Returns a string representation of the instance Urn.

(Inherited from SfcInstance)
UpdateUIPropertyState() UpdateUIPropertyState() UpdateUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Validate() Validate() Validate()

Indicates the basic child object's validation. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)

Explicit Interface Implementations

ISfcAlterable.ScriptAlter() ISfcAlterable.ScriptAlter() ISfcAlterable.ScriptAlter()

This method is for internal use only.

ISfcRenamable.Rename(SfcKey) ISfcRenamable.Rename(SfcKey) ISfcRenamable.Rename(SfcKey)

This method is for internal use only.

ISfcRenamable.ScriptRename(SfcKey) ISfcRenamable.ScriptRename(SfcKey) ISfcRenamable.ScriptRename(SfcKey)

This method is for internal use only.

Events

propertyChanged propertyChanged propertyChanged

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PropertyChanged PropertyChanged PropertyChanged

Occurs when a property value changes.

(Inherited from SfcInstance)
propertyMetadataChanged propertyMetadataChanged propertyMetadataChanged

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

Occurs when a property metadata value changes.

(Inherited from SfcInstance)
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged

Occurs when the metadata for a property has changed.

(Inherited from SfcInstance)

Applies to