DtsConnectionAttribute Class

Article
04/26/2013

Supplies design time information about a ConnectionManager object.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.SqlServer.Dts.Runtime.Localization.DtsLocalizableAttribute
      Microsoft.SqlServer.Dts.Runtime.DtsConnectionAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := False, AllowMultiple := False)> _
Public NotInheritable Class DtsConnectionAttribute _
    Inherits DtsLocalizableAttribute
'Usage
Dim instance As DtsConnectionAttribute

[AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
public sealed class DtsConnectionAttribute : DtsLocalizableAttribute

[AttributeUsageAttribute(AttributeTargets::Class, Inherited = false, AllowMultiple = false)]
public ref class DtsConnectionAttribute sealed : public DtsLocalizableAttribute

[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = false)>]
type DtsConnectionAttribute =  
    class 
        inherit DtsLocalizableAttribute 
    end

public final class DtsConnectionAttribute extends DtsLocalizableAttribute

The DtsConnectionAttribute type exposes the following members.

Constructors

	Name	Description
	DtsConnectionAttribute	Initializes a new instance of the DtsConnectionAttribute class.

Top

Properties

	Name	Description
	ConnectionContact	Gets or sets a String that contains the contact information for the connection manager.
	ConnectionType	Gets or sets the type of the connection manager. This property is required.
	Description	Infrastructure. Gets or sets the description of the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
	DisplayName	Infrastructure. Gets or sets the display name of the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
	IconResource	Gets or sets the icon associated with the connection manager object.
	LocalizationType	Infrastructure. Gets or sets the class that supplies values for the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
	TypeId	(Inherited from Attribute.)
	UITypeName	Specifies the qualified name of the assembly that implements the user interface of the connection manager.

Top

Methods

	Name	Description
	Equals	(Inherited from Attribute.)
	GetHashCode	(Inherited from Attribute.)
	GetType	(Inherited from Object.)
	IsDefaultAttribute	(Inherited from Attribute.)
	Match	(Inherited from Attribute.)
	ToString	(Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	(Inherited from Attribute.)
	_Attribute.GetTypeInfo	(Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	(Inherited from Attribute.)
	_Attribute.Invoke	(Inherited from Attribute.)

Top

Remarks

This attribute is applied to managed Integration Services connection managers that are derived from ConnectionManagerBase. The attribute identifies a class as a managed connection manager and provides information through its properties that control how the SSIS Designer displays and interacts with the object.

The DisplayName and ConnectionType properties are required properties. The DisplayName is displayed in the list of connection managers in SQL Server Data Tools (SSDT).

Examples

The following example shows a class that implements this attribute.

  [DtsConnection(DisplayName = "MyConnectionManager",
    Description = "Custom Connection Manager for Testing",
    IconResource = "MyConnectionManager.MyConnectionMgrIcon.ico",
    UITypeName = "MyNamespace.MyConnectionManagerClassName," +
    "MyAssemblyName,Version=1.00.000.00,Culture=neutral,PublicKeyToken=")]
public class MyConnnectionMgr : ConnectionManagerBase
{
}

<DtsConnection(DisplayName:="MyConnectionManager", _
  Description:="Custom Connection Manager for Testing", _
  IconResource:="MyConnectionManager.MyConnectionMgrIcon.ico", _
  UITypeName:="MyNamespace.MyConnectionManagerClassName,MyAssemblyName," & _
  "Version=1.00.000.00,Culture=neutral,PublicKeyToken=")> _
Public Class MyConnnectionMgr
     Inherits ConnectionManagerBase
End Class

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.

Share via