Share via

  • Article

ExtendedProperty Class

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

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

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.

Inheritance Hierarchy

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

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.