PipelineComponentInfo.IconResource Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns the icon associated with the component object. This property is read-only.
public:
property System::String ^ IconResource { System::String ^ get(); };
public string IconResource { get; }
member this.IconResource : string
Public ReadOnly Property IconResource As String
Property Value
A String that indicates the icon resource of the component.
Examples
The following code sample retrieves the information about the pipeline components from the PipelineComponentInfos collection. The sample iterates through the collection, and then prints the values for the properties in each PipelineComponentInfo, including the IconResource.
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
namespace TaskInfos_Item
{
class Program
{
static void Main(string[] args)
{
Application app = new Application();
PipelineComponentInfos pInfos = app.PipelineComponentInfos;
// Iterate through the collection,
// printing values for the properties.
foreach (PipelineComponentInfo pInfo in pInfos)
{
Console.WriteLine("ComponentType: {0}", pInfo.ComponentType);
Console.WriteLine("CreationName: {0}", pInfo.CreationName);
Console.WriteLine("Description: {0}", pInfo.Description);
Console.WriteLine("FileName: {0}", pInfo.FileName);
//Console.WriteLine("FileNameVersionString: {0}", pInfo.FileNameVersionString);
Console.WriteLine("IconFile: {0}", pInfo.IconFile);
Console.WriteLine("IconResource: {0}", pInfo.IconResource);
Console.WriteLine("ID: {0}", pInfo.ID);
Console.WriteLine("Name: {0}", pInfo.Name);
Console.WriteLine("NoEditor: {0}", pInfo.NoEditor);
Console.WriteLine("ShapeProgID: {0}", pInfo.ShapeProgID);
Console.WriteLine("UITypeName: {0}", pInfo.UITypeName);
Console.WriteLine("--------------------------------------");
}
}
}
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Namespace TaskInfos_Item
Class Program
Shared Sub Main(ByVal args() As String)
Dim app As Application = New Application()
Dim pInfos As PipelineComponentInfos = app.PipelineComponentInfos
' Iterate through the collection,
' printing values for the properties.
Dim pInfo As PipelineComponentInfo
For Each pInfo In pInfos
Console.WriteLine("ComponentType: {0}", pInfo.ComponentType)
Console.WriteLine("CreationName: {0}", pInfo.CreationName)
Console.WriteLine("Description: {0}", pInfo.Description)
Console.WriteLine("FileName: {0}", pInfo.FileName)
'Console.WriteLine("FileNameVersionString: {0}", pInfo.FileNameVersionString)
Console.WriteLine("IconFile: {0}", pInfo.IconFile)
Console.WriteLine("IconResource: {0}", pInfo.IconResource)
Console.WriteLine("ID: {0}", pInfo.ID)
Console.WriteLine("Name: {0}", pInfo.Name)
Console.WriteLine("NoEditor: {0}", pInfo.NoEditor)
Console.WriteLine("ShapeProgID: {0}", pInfo.ShapeProgID)
Console.WriteLine("UITypeName: {0}", pInfo.UITypeName)
Console.WriteLine("--------------------------------------")
Next
End Sub
End Class
Sample Output:
ComponentType: Transform
CreationName: DTSTransform.Merge.1
Description: Merge Transformation
FileName: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMerge.dll
IconFile: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMerge.dll
IconResource: -201
ID: {08AE886A-4124-499C-B332-16E3299D225A}
Name: Merge
NoEditor: False
ShapeProgID:
UITypeName: Microsoft.DataTransformationServices.DataFlowUI.MergeUI, Microsoft.DatatransformationServices.DataFlowUI, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91
--------------------------------------
ComponentType: Transform
CreationName: DTSTransform.MergeJoin.1
Description: Merge Join Transformation
FileName: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMergeJoin.dll
IconFile: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMergeJoin.dll
IconResource: -201
ID: {0D598A60-0A32-4B1B-A72C-5030B64E3A20}
Name: Merge Join
NoEditor: False
ShapeProgID:
UITypeName: Microsoft.DataTransformationServices.Design.DtsMergeJoinComponentUI, Microsoft.DatatransformationServices.DataFlowUI, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91
--------------------------------------
Remarks
When the component is added to the data flow task, this property controls the icons that are shown in the Data Flow Items toolbox and on the data flow task designer surface.