ExtendedProperty Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This class contains members that hold additional information about a package.

public ref class ExtendedProperty sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, IDisposable, Microsoft::SqlServer::Dts::Runtime::IDTSName, Microsoft::SqlServer::Dts::Runtime::IDTSPersist, System::ComponentModel::IComponent

public sealed class ExtendedProperty : Microsoft.SqlServer.Dts.Runtime.DtsObject, IDisposable, Microsoft.SqlServer.Dts.Runtime.IDTSName, Microsoft.SqlServer.Dts.Runtime.IDTSPersist, System.ComponentModel.IComponent

type ExtendedProperty = class
    inherit DtsObject
    interface IDTSPersist
    interface IDTSName
    interface IComponent
    interface IDisposable

Public NotInheritable Class ExtendedProperty
Inherits DtsObject
Implements IComponent, IDisposable, IDTSName, IDTSPersist

Inheritance: Object

DtsObject
ExtendedProperty

Implements: IDTSName IDTSPersist IComponent IDisposable

Remarks

The ExtendedProperties collection lets custom information be stored with a package. For example, SSIS Designer itself stores package layout information in extended properties. Although the package extended properties of the package are hidden at design time and ignored at run time, they are persisted with the package and provide a convenient way to attach user-defined information or metadata to a package for possible use by an automated process or custom tool.

Each ExtendedProperty has a Name, a Description, a DataType, and a Value. Use the ExtendedProperties property of the Package to access its extended properties collection, and use the Add method of the collection to add a new extended property.

Properties

CreationName	Returns the string that is used by the run-time engine to create an instance of the ExtendedProperty object and to add the object to the ExtendedProperties collection. This property is read-only.
DataType	Gets the DataType of the value stored in this instance for the package. This field is read-only.
Description	Gets or sets the description related to the property stored in this instance.
ID	Gets the GUID for this instance.
Name	Gets or sets a name for what is stored in this instance.
Namespace	Gets or sets the namespace associated with this information.
Site	Gets or sets the site of the property.
Value	Gets or sets the value for the information stored in this instance.

Methods

Dispose()	Releases the resources used by the instance of this class.
Equals(Object)	Determines whether two object instances are equal. (Inherited from DtsObject)
GetHashCode()	Returns the hash code for this instance. (Inherited from DtsObject)
LoadFromXML(XmlNode, IDTSEvents)	This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method
SaveToXML(XmlDocument, XmlNode, IDTSEvents)	This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

Events

Disposed

Adds an event handler to listen to the Disposed event.

Applies to

Sdílet prostřednictvím