ExtendedProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains a collection of ExtendedProperty objects. This class cannot be inherited.
public ref class ExtendedProperties sealed : Microsoft::SqlServer::Dts::Runtime::DTSReadOnlyCollectionBasepublic sealed class ExtendedProperties : Microsoft.SqlServer.Dts.Runtime.DTSReadOnlyCollectionBasetype ExtendedProperties = class
inherit DTSReadOnlyCollectionBasePublic NotInheritable Class ExtendedProperties
Inherits DTSReadOnlyCollectionBase- Inheritance
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.
Fields
| m_unmanagedColl |
The unmanaged collection. (Inherited from DTSReadOnlyCollectionBase) |
Properties
| Count |
Gets the number of elements contained in the DTSReadOnlyCollectionBase instance. (Inherited from DTSReadOnlyCollectionBase) |
| IsSynchronized |
Gets a value that indicates whether access to the DTSReadOnlyCollectionBase is synchronized (thread-safe). (Inherited from DTSReadOnlyCollectionBase) |
| Item[Object] |
Gets an ExtendedProperty object from the collection. |
| SyncRoot |
Gets an object that can be used to synchronize access to the DTSReadOnlyCollectionBase. (Inherited from DTSReadOnlyCollectionBase) |
Methods
| Add(String, String, Object) |
Adds a new, empty ExtendedProperty object to the end of the collection. |
| Contains(Object) |
Returns a Boolean that indicates whether the items in the collection can be accessed using indexing without throwing an exception. |
| CopyTo(Array, Int32) |
Copies the entire DTSReadOnlyCollectionBase to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from DTSReadOnlyCollectionBase) |
| CreateManagedObject(Object) |
Creates managed object from an unmanaged object. (Inherited from DTSReadOnlyCollectionBase) |
| GetCount() |
Retrieves the number of objects in the collection. (Inherited from DTSReadOnlyCollectionBase) |
| GetEnumerator() |
Returns an ExtendedPropertyEnumerator for iterating over the ExtendedProperties collection. |
| GetManagedEnumerator(Object) |
Gets the managed enumerator from an unmanaged enumerator. (Inherited from DTSReadOnlyCollectionBase) |
| Remove(Object) |
Removes an ExtendedProperty object from the ExtendedProperties collection. |