• Article

DtsPipelineComponentAttribute.IconResource Property

Gets or sets the icon used to represent the component in the toolbox.

Namespace:  Microsoft.SqlServer.Dts.Pipeline
Assembly:  Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)

Syntax

'Declaration
Public Property IconResource As String
    Get
    Set
'Usage
Dim instance As DtsPipelineComponentAttribute
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 used to represent the component in the toolbox.

Remarks

This property controls the icons that are shown in the Data Flow toolbox and on the design surface of the data flow tab when the component is added to the data flow.

The Data Flow toolbox uses the 16x16, 16-color image type, while the design surface of the data flow tab uses the 32x32, 16-color image type. Both are default image types for icons created using Microsoft Visual Studio.

The format of the string identifying the icon resource is a dotted notation, consisting of the name of the root namespace for the assembly, followed by a period, then the name of the icon file.

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

Examples

The following example shows a component class that provides an icon resource.

using System;
using Microsoft.SqlServer.Dts.Pipeline;
namespace DtsDocumentation
{
   [DtsPipelineComponent(DisplayName="MyComponent",IconResource="DtsDocumentation.MyComponentIcon.ico")]
   public class MyComponent : PipelineComponent
   {
   }
}

Imports System 
Imports Microsoft.SqlServer.Dts.Pipeline 
Namespace DtsDocumentation 

 <DtsPipelineComponent(DisplayName="MyComponent", IconResource="DtsDocumentation.MyComponentIcon.ico")> _ 
 Public Class MyComponent 
 Inherits PipelineComponent 
 End Class 
End Namespace