• Article

ExtendedProperty Class

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

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.ExtendedProperty

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public NotInheritable Class ExtendedProperty _
    Inherits DtsObject _
    Implements IDTSPersist, IDTSName, IComponent, IDisposable
'Usage
Dim instance As ExtendedProperty

public sealed class ExtendedProperty : DtsObject, 
    IDTSPersist, IDTSName, IComponent, IDisposable

public ref class ExtendedProperty sealed : public DtsObject, 
    IDTSPersist, IDTSName, IComponent, IDisposable

[<SealedAttribute>]
type ExtendedProperty =  
    class
        inherit DtsObject
        interface IDTSPersist
        interface IDTSName
        interface IComponent
        interface IDisposable
    end

public final class ExtendedProperty extends DtsObject implements IDTSPersist, IDTSName, IComponent, IDisposable

The ExtendedProperty type exposes the following members.

Properties

  Name Description
Public property 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.
Public property DataType Gets the DataType of the value stored in this instance for the package. This field is read-only.
Public property Description Gets or sets the description related to the property stored in this instance.
Public property ID Gets the GUID for this instance.
Public property Name Gets or sets a name for what is stored in this instance.
Public property Namespace Gets or sets the namespace associated with this information.
Public property Site Infrastructure.
Public property Value Gets or sets the value for the information stored in this instance.

Top

Methods

  Name Description
Public method Dispose Releases the resources used by the instance of this class.
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public method LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method
Protected method MemberwiseClone (Inherited from Object.)
Public method SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method ToString (Inherited from Object.)

Top

Events

  Name Description
Public event Disposed Adds an event handler to listen to the Disposed event.

Top

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.

Thread Safety

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