Share via

  • Article

ExtendedProperties Class

Contains a collection of ExtendedProperty objects. This class cannot be inherited.

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

Syntax

'Declaration
Public NotInheritable Class ExtendedProperties _
    Inherits DTSReadOnlyCollectionBase
'Usage
Dim instance As ExtendedProperties

public sealed class ExtendedProperties : DTSReadOnlyCollectionBase

public ref class ExtendedProperties sealed : public DTSReadOnlyCollectionBase

[<SealedAttribute>]
type ExtendedProperties =  
    class
        inherit DTSReadOnlyCollectionBase
    end

public final class ExtendedProperties extends DTSReadOnlyCollectionBase

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 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.DTSReadOnlyCollectionBase
    Microsoft.SqlServer.Dts.Runtime.ExtendedProperties

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.