DtsConnectionAttribute.IconResource Property

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

public string IconResource { get; set; }

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

/** @property */
public String get_IconResource ()

/** @property */
public void set_IconResource (String value)

public function get IconResource () : String

public function set IconResource (value : String)

Property Value

A String that identifies the icon resource of the connection manager.

Remarks

Updated sample code:15 September 2007

When specified, this property identifies the icon shown in Business Intelligence Development Studio 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 2005, set the icon file's Build Action attribute to Embedded Resource.

Example

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

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

DtsConnectionAttribute Class
DtsConnectionAttribute Members
Microsoft.SqlServer.Dts.Runtime Namespace

Change History