DtsTaskAttribute.IconResource Property


Gets or sets the icon associated with the task object.

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

public string IconResource { get; set; }

Property Value

Type: System.String

A string that identifies the icon resource of the task.

When specified, this property identifies the icons that are shown in the Control Flow Items Toolbox and on the package Control Flow designer surface when the task is added to a package.

The Control Flow Items Toolbox uses the 16x16, 16 colors image type and the data flow designer surface uses the 32x32, 16 colors image type that are the default image types of icons created using Visual Studio .NET.

The format of the string that identifies the icon resource is a dotted notation that consists of the name of the assembly and the name of the icon file, separated by a period (.).

To embed an icon file as a resource in an assembly using Visual Studio .NET, create a new icon, and then set the icon file's Build Action attribute to Embedded Resource in the Visual Studio Properties window.

The following example shows a task class that provides an icon resource. In this example, the icon file is named MyTaskIcon.ico, and the assembly name is MyTask.

using System;
using Microsoft.SqlServer.Dts.Runtime;
namespace Microsoft.SSIS.Samples
   DisplayName = "MyTask",
   IconResource = "MyTask.MyTaskIcon.ico",
   UITypeName = "My Custom Task," +
   "Version=," +
   "Culture = Neutral," +
   "PublicKeyToken = 12345abc6789de01",
   TaskType = "PackageMaintenance",
   TaskContact = "MyTask; company name; any other information",
   RequiredProductLevel = DTSProductLevel.None
  public class MyTask : Task
    // Your code here.
Return to top