DtsConnectionAttribute.IconResource Property

  • Article

Gets or sets the icon associated with the connection manager object.

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

Syntax

'Declaration
Public Property IconResource As String 
    Get 
    Set
'Usage
Dim instance As DtsConnectionAttribute 
Dim value As String 

value = instance.IconResource

instance.IconResource = value

public string IconResource { get; set; }

public:
property String^ IconResource {
    String^ get ();
    void set (String^ value);
}

member IconResource : string with get, set

function get IconResource () : String 
function set IconResource (value : String)

Property Value

Type: System.String
A String that identifies the icon resource of the connection manager.

Remarks

When specified, this property identifies the icon shown in SQL Server Data Tools (SSDT) when the connection manager is displayed.

The string should contain the name of the assembly and the name of the icon file. To embed an icon file as a resource in an assembly using Visual Studio 2010, set the icon file's Build Action attribute to Embedded Resource.

Examples

The following example shows a connection manager class that provides an icon resource. In this example, the icon file is named MyConnectionMgrIcon.ico, and the assembly name is MyConnectionManager.

using system;
using Microsoft.SqlServer.Dts.Runtime;
namespace Microsoft.SqlServer.SSIS.Samples
{
  [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=")]
    {
    }
}

Imports system
Imports Microsoft.SqlServer.Dts.Runtime
<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 MyConnectionManager
     Inherits ConnectionManagerBase
End Class

See Also

Reference

DtsConnectionAttribute Class

Microsoft.SqlServer.Dts.Runtime Namespace