Share via


ExtendedProperties Class

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

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DTSReadOnlyCollectionBase
    Microsoft.SqlServer.Dts.Runtime.ExtendedProperties

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

The ExtendedProperties type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of elements contained in the DTSReadOnlyCollectionBase instance. (Inherited from DTSReadOnlyCollectionBase.)
Public property IsSynchronized Gets a value that indicates whether access to the DTSReadOnlyCollectionBase is synchronized (thread-safe). (Inherited from DTSReadOnlyCollectionBase.)
Public property Item Gets an ExtendedProperty object from the collection.
Public property SyncRoot Gets an object that can be used to synchronize access to the DTSReadOnlyCollectionBase. (Inherited from DTSReadOnlyCollectionBase.)

Top

Methods

  Name Description
Public method Add Adds a new, empty ExtendedProperty object to the end of the collection.
Public method Contains Returns a Boolean that indicates whether the items in the collection can be accessed using indexing without throwing an exception.
Public method CopyTo Copies the entire DTSReadOnlyCollectionBase to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from DTSReadOnlyCollectionBase.)
Public method Equals (Inherited from Object.)
Public method GetEnumerator Returns an ExtendedPropertyEnumerator for iterating over the ExtendedProperties collection.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Remove Removes an ExtendedProperty object from the ExtendedProperties collection.
Public method ToString (Inherited from Object.)

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 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.

See Also

Reference

Microsoft.SqlServer.Dts.Runtime Namespace