Export (0) Print
Expand All

ExtendedProperties Class

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

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)

[DefaultMemberAttribute("Item")]
public sealed class ExtendedProperties : DTSReadOnlyCollectionBase

The ExtendedProperties type exposes the following members.

  NameDescription
Public propertyCountGets the number of elements contained in the DTSReadOnlyCollectionBase instance. (Inherited from DTSReadOnlyCollectionBase.)
Public propertyIsSynchronizedGets a value that indicates whether access to the DTSReadOnlyCollectionBase is synchronized (thread-safe). (Inherited from DTSReadOnlyCollectionBase.)
Public propertyItemGets an ExtendedProperty object from the collection.
Public propertySyncRootGets an object that can be used to synchronize access to the DTSReadOnlyCollectionBase. (Inherited from DTSReadOnlyCollectionBase.)
Top

  NameDescription
Public methodAddAdds a new, empty ExtendedProperty object to the end of the collection.
Public methodContainsReturns a Boolean that indicates whether the items in the collection can be accessed using indexing without throwing an exception.
Public methodCopyToCopies the entire DTSReadOnlyCollectionBase to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from DTSReadOnlyCollectionBase.)
Public methodEquals (Inherited from Object.)
Public methodGetEnumeratorReturns an ExtendedPropertyEnumerator for iterating over the ExtendedProperties collection.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodRemoveRemoves an ExtendedProperty object from the ExtendedProperties collection.
Public methodToString (Inherited from Object.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft