ForEachEnumeratorInfo.Description Property

Gets or sets a description for the ForEachEnumerator.

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

Syntax

'Declaration
Public Property Description As String 
    Get 
    Set
'Usage
Dim instance As ForEachEnumeratorInfo 
Dim value As String 

value = instance.Description

instance.Description = value

public string Description { get; set; }

public:
virtual property String^ Description {
    String^ get () sealed;
    void set (String^ value) sealed;
}

abstract Description : string with get, set 
override Description : string with get, set

final function get Description () : String 
final function set Description (value : String)

Property Value

Type: System.String
A String that contains the ForEachEnumerator description.

Implements

IDTSName.Description

Remarks

This description is often used in the graphical user interface in the Description property. This property is not required; however, it is useful to have descriptions.

Examples

The following code example retrieves each ForEachEnumeratorInfo from the ForEachEnumeratorInfos collection, and then prints the values for each property, including the Description.

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();
            ForEachEnumeratorInfos feInfos = app.ForEachEnumeratorInfos;

            // Iterate through the collection, 
            // printing values for the properties.
            foreach (ForEachEnumeratorInfo feInfo in feInfos)
            {
                Console.WriteLine("CreationName:   {0}", feInfo.CreationName);
                Console.WriteLine("Description     {0}", feInfo.Description);
                Console.WriteLine("FileName        {0}", feInfo.FileName);
                //Console.WriteLine("FileNameVersionString   {0}", feInfo.FileNameVersionString);
                Console.WriteLine("ForEachEnumeratorContact {0}", feInfo.ForEachEnumeratorContact);
                Console.WriteLine("ID              {0}", feInfo.ID);
                Console.WriteLine("Name            {0}", feInfo.Name);
                Console.WriteLine("UITypeName      {0}", feInfo.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 feInfos As ForEachEnumeratorInfos =  app.ForEachEnumeratorInfos 
 
            ' Iterate through the collection, 
            ' printing values for the properties.
            Dim feInfo As ForEachEnumeratorInfo
            For Each feInfo In feInfos
                Console.WriteLine("CreationName:   {0}", feInfo.CreationName)
                Console.WriteLine("Description     {0}", feInfo.Description)
                Console.WriteLine("FileName        {0}", feInfo.FileName)
                'Console.WriteLine("FileNameVersionString   {0}", feInfo.FileNameVersionString)
                Console.WriteLine("ForEachEnumeratorContact {0}", feInfo.ForEachEnumeratorContact)
                Console.WriteLine("ID              {0}", feInfo.ID)
                Console.WriteLine("Name            {0}", feInfo.Name)
                Console.WriteLine("UITypeName      {0}", feInfo.UITypeName)
                Console.WriteLine("----------------------------")
            Next
        End Sub
    End Class
End Namespace

Sample Output:

CreationName: DTS.ForEachFileEnumerator.1

Description Provides a file system enumerator

FileName C:\Program Files\Microsoft SQL Server\100\DTS\ForEachEnumerators\ForEachFileEnumerator.dll

ForEachEnumeratorContact

ID {62C3D0D9-C6A3-4A08-84F3-6028B2452F41}

Name For Each File Enumerator

UITypeName Microsoft.SqlServer.Dts.Runtime.Enumerators.File.ForEachFileEnumeratorUI, Microsoft.SqlServer.ForEachFileEnumeratorUI, Version=10.0.000.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91

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

CreationName: DTS.ForEachItemEnumerator.1

Description Enumerates items in a collection of items

FileName C:\Program Files\Microsoft SQL Server\100\DTS\Binn\DTS.dll

ForEachEnumeratorContact

ID {62C3D0DC-C6A3-4A08-84F3-6028B2452F41}

Name For Each Item Enumerator

UITypeName Microsoft.SqlServer.Dts.Runtime.Enumerators.Item.ForEachItemEnumUI, Microsoft.SqlServer.ForEachItemEnumeratorUI, Version=10.0.000.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91

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

See Also

Reference

ForEachEnumeratorInfo Class

Microsoft.SqlServer.Dts.Runtime Namespace