ExtendedProperty Class

 

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

Namespace:   Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

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

public sealed class ExtendedProperty : DtsObject, IDTSPersist, 
	IDTSName, IComponent, IDisposable

NameDescription
System_CAPS_pubpropertyCreationName

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

System_CAPS_pubpropertyDataType

Gets the DataType of the value stored in this instance for the package. This field is read-only.

System_CAPS_pubpropertyDescription

Gets or sets the description related to the property stored in this instance.

System_CAPS_pubpropertyID

Gets the GUID for this instance.

System_CAPS_pubpropertyName

Gets or sets a name for what is stored in this instance.

System_CAPS_pubpropertyNamespace

Gets or sets the namespace associated with this information.

System_CAPS_pubpropertySite

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the site of the property.

System_CAPS_pubpropertyValue

Gets or sets the value for the information stored in this instance.

NameDescription
System_CAPS_pubmethodDispose()

Releases the resources used by the instance of this class.

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method

System_CAPS_pubmethodSaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventDisposed

Adds an event handler to listen to the Disposed event.

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.

Return to top
Show: