TaskInfo.IconFile Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Returns the fully qualified name of the file that holds the icon for the task. This property is read-only.

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

public string IconFile { get; }

member this.IconFile : string

Public ReadOnly Property IconFile As String

Property Value

String

A String that contains the fully qualified name of the file that holds the icon for the task.

Examples

The following code retrieves the TaskInfos collection from the application, iterates through each property of each TaskInfo in the collection, and then prints the values of each property, including the IconFile.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;

namespace TaskType
{
    class Program
    {
        static void Main(string[] args)
        {
            Application myApp = new Application();
            TaskInfos tInfos = myApp.TaskInfos;

            // Iterate through the collection, 
            // printing values for the properties.
            foreach (TaskInfo tInfo in tInfos)
            {
                Console.WriteLine("CreationName:   {0}", tInfo.CreationName);
                Console.WriteLine("Description     {0}", tInfo.Description);
                Console.WriteLine("FileName        {0}", tInfo.FileName);
                // Console.WriteLine("FileNameVersionString   {0}", tInfo.FileNameVersionString);
                Console.WriteLine("IconFile        {0}", tInfo.IconFile);
                Console.WriteLine("IconResource    {0}", tInfo.IconResource);
                Console.WriteLine("ID              {0}", tInfo.ID);
                Console.WriteLine("Name            {0}", tInfo.Name);
                // Console.WriteLine("TaskContact     {0}", tInfo.TaskContact);
                Console.WriteLine("TaskType        {0}", tInfo.TaskType);
                Console.WriteLine("UITypeName      {0}", tInfo.UITypeName);
                Console.WriteLine("----------------------------");
            }
            Console.WriteLine();
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime


Namespace TaskType
    _
   Class Program
      
      'Entry point which delegates to C-style main Private Function
      Public Overloads Shared Sub Main()
         Main(System.Environment.GetCommandLineArgs())
      End Sub
      
      Overloads Shared Sub Main(args() As String)
         Dim myApp As New Application()
         Dim tInfos As TaskInfos = myApp.TaskInfos
         
         ' Iterate through the collection, 
         ' printing values for the properties.
         Dim tInfo As TaskInfo
         For Each tInfo In  tInfos
            Console.WriteLine("CreationName:   {0}", tInfo.CreationName)
            Console.WriteLine("Description     {0}", tInfo.Description)
            Console.WriteLine("FileName        {0}", tInfo.FileName)
            ' Console.WriteLine("FileNameVersionString   {0}", tInfo.FileNameVersionString)
            Console.WriteLine("IconFile        {0}", tInfo.IconFile)
            Console.WriteLine("IconResource    {0}", tInfo.IconResource)
            Console.WriteLine("ID              {0}", tInfo.ID)
            Console.WriteLine("Name            {0}", tInfo.Name)
            ' Console.WriteLine("TaskContact     {0}", tInfo.TaskContact)
            Console.WriteLine("TaskType        {0}", tInfo.TaskType)
            Console.WriteLine("UITypeName      {0}", tInfo.UITypeName)
            Console.WriteLine("----------------------------")
         Next tInfo
         Console.WriteLine()
      End Sub 'Main
   End Class 'Program
End Namespace 'TaskType

Sample Output:

CreationName: Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTask, Microsoft.SqlServer.ScriptTask, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

Description Provides interactive custom task authoring

FileName Microsoft.SqlServer.ScriptTask

IconFile Microsoft.SqlServer.ScriptTask

IconResource TaskIcon

ID Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTask, Microsoft.SqlServer.ScriptTask, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

Name Script Task

TaskType DTS100

UITypeName Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=10.00.000.00, Culture=Neutral, PublicKeyToken=89845dcd8080cc91

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

CreationName: Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTask, Microsoft.SqlServer.SendMailTask, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

Description Sends an e-mail message.

FileName Microsoft.SqlServer.SendMailTask

IconFile Microsoft.SqlServer.SendMailTask

IconResource TaskIcon

ID Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTask, Microsoft.SqlServer.SendMailTask, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

Name Send Mail Task

TaskType DTS100

UITypeName Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskUI, Microsoft.SqlServer.SendMailTaskUI, Version=10.00.000.00, Culture=Neutral, PublicKeyToken=89845dcd8080cc91

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