PipelineComponentInfo.IconFile Property

Returns the name of the file that contains the icon. This property is read-only.

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

Syntax

'Declaration
Public ReadOnly Property IconFile As String

public string IconFile { get; }

public:
property String^ IconFile {
    String^ get ();
}

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

public function get IconFile () : String

Property Value

A String that contains the name of the file that contains the icon.

Example

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 IconFile.

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\90\DTS\PipelineComponents\TxMerge.dll

FileNameVersionString: 2000.90.1049.0

IconFile: C:\Program Files\Microsoft SQL Server\90\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=9.0.242.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

--------------------------------------

ComponentType: Transform

CreationName: DTSTransform.MergeJoin.1

Description: Merge Join Transformation

FileName: C:\Program Files\Microsoft SQL Server\90\DTS\PipelineComponents\TxMergeJoin.dll

FileNameVersionString: 2000.90.1049.0

IconFile: C:\Program Files\Microsoft SQL Server\90\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=9.0.242.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

--------------------------------------

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

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