Share via


DtsProperty Class

Contains properties and methods used by several containers on their properties. This class cannot be inherited.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public NotInheritable Class DtsProperty _
    Inherits DtsObject
'Usage
Dim instance As DtsProperty
public sealed class DtsProperty : DtsObject
public ref class DtsProperty sealed : public DtsObject
[<SealedAttribute>]
type DtsProperty =  
    class 
        inherit DtsObject 
    end
public final class DtsProperty extends DtsObject

The DtsProperty type exposes the following members.

Properties

  Name Description
Public property ConnectionType Returns the name of the connection manager used to create the connection. This field is read-only.
Public property Get Returns a Boolean that indicates whether a property value can be read. This field is read-only.
Public property Name Returns the name of the property. This field is read-only.
Public property PropertyKind Gets the DTSPropertyKind enumeration that contains information about the custom attributes on a property. This information is used by the designer.
Public property Set Returns a Boolean that indicates whether the referenced object property is changeable. This field is read-only.
Public property Type Returns the data type of the parameter. This field is read-only.
Public property TypeConverter Returns the assembly-qualified type name of the type converter object for the property.
Public property UITypeEditor Returns the assembly-qualified type name of the graphical editor for the property. This type is read-only.

Top

Methods

  Name Description
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method GetExport Returns the export flag for the specified object.
Public method GetExpression Returns a String that contains the expression for the specified object. Null means no expression is assigned.
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetPackagePath Returns a String that contains the relative path to the location of the specified package.
Public method GetType (Inherited from Object.)
Public method GetValue Returns the value of the property.
Public method SetExport Sets the export flag for the specified object.
Public method SetExpression Assigns the specified expression to the object. Specify nulla null reference (Nothing in Visual Basic) to remove an existing expression from the property.
Public method SetValue Sets the value of the property.
Public method ToString (Inherited from Object.)

Top

Remarks

Several containers implement the IDTSPropertiesProvider interface. It provides the inheritors acess to Properties collection, which is a collection of the properties that the container has. It's useful to iterate over this Properties collection instead of accessing each property individually. The Properties collection returns a DtsProperties object, and each individual object in the collection is a DtsProperty object. Because the collection of DtsProperty objects is stored in a DtsProperties collection, you can iterate over the collection using the foreach (For Each in Microsoft Visual Basic) syntax or the PropertyEnumerator and view the properties that this class has.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Dts.Runtime Namespace