ExtendedProperty ExtendedProperty ExtendedProperty Class

Definition

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
Public NotInheritable Class ExtendedProperty
Inherits DtsObject
Implements IComponent, IDisposable, IDTSName, IDTSPersist
Inheritance
ExtendedPropertyExtendedPropertyExtendedProperty
Implements

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 CreationName 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 DataType DataType

Gets the DataType of the value stored in this instance for the package. This field is read-only.

Description Description Description

Gets or sets the description related to the property stored in this instance.

ID ID ID

Gets the GUID for this instance.

Name Name Name

Gets or sets a name for what is stored in this instance.

Namespace Namespace Namespace

Gets or sets the namespace associated with this information.

Site Site Site

Gets or sets the site of the property.

Value Value Value

Gets or sets the value for the information stored in this instance.

Methods

Dispose() Dispose() Dispose()

Releases the resources used by the instance of this class.

Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents) 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) SaveToXML(XmlDocument, XmlNode, IDTSEvents) 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 Disposed Disposed

Adds an event handler to listen to the Disposed event.

Applies to