ExtendedProperties Class
TOC
Collapse the table of content
Expand the table of content

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)

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

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

NameDescription
System_CAPS_pubpropertyCount

Gets the number of elements contained in the DTSReadOnlyCollectionBase instance.(Inherited from DTSReadOnlyCollectionBase.)

System_CAPS_pubpropertyIsSynchronized

Gets a value that indicates whether access to the DTSReadOnlyCollectionBase is synchronized (thread-safe).(Inherited from DTSReadOnlyCollectionBase.)

System_CAPS_pubpropertyItem[Object]

Gets an ExtendedProperty object from the collection.

System_CAPS_pubpropertySyncRoot

Gets an object that can be used to synchronize access to the DTSReadOnlyCollectionBase.(Inherited from DTSReadOnlyCollectionBase.)

NameDescription
System_CAPS_pubmethodAdd(String, String, Object)

Adds a new, empty ExtendedProperty object to the end of the collection.

System_CAPS_pubmethodContains(Object)

Returns a Boolean that indicates whether the items in the collection can be accessed using indexing without throwing an exception.

System_CAPS_pubmethodCopyTo(Array, Int32)

Copies the entire DTSReadOnlyCollectionBase to a compatible one-dimensional array, starting at the specified index of the target array.(Inherited from DTSReadOnlyCollectionBase.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns an ExtendedPropertyEnumerator for iterating over the ExtendedProperties collection.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodRemove(Object)

Removes an ExtendedProperty object from the ExtendedProperties collection.

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

Return to top
Show:
© 2016 Microsoft