Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ExtendedProperty Class

This class contains members that hold additional information about a package.

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.ExtendedProperty

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
public sealed class ExtendedProperty : DtsObject, 
	IDTSPersist, IDTSName, IComponent, IDisposable

The ExtendedProperty type exposes the following members.

  NameDescription
Public propertyCreationNameReturns the string that is used by the run-time engine to create an instance of the ExtendedProperty object and to add the object to the ExtendedProperties collection. This property is read-only.
Public propertyDataTypeGets the DataType of the value stored in this instance for the package. This field is read-only.
Public propertyDescriptionGets or sets the description related to the property stored in this instance.
Public propertyIDGets the GUID for this instance.
Public propertyNameGets or sets a name for what is stored in this instance.
Public propertyNamespaceGets or sets the namespace associated with this information.
Public propertySiteInfrastructure. Gets or sets the site of the property.
Public propertyValueGets or sets the value for the information stored in this instance.
Top
  NameDescription
Public methodDisposeReleases the resources used by the instance of this class.
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetType (Inherited from Object.)
Public methodLoadFromXMLThis method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public methodToString (Inherited from Object.)
Top
  NameDescription
Public eventDisposedAdds an event handler to listen to the Disposed event.
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 package 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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.