Share via


DtsForEachEnumeratorAttribute.UITypeName Property

Definition

Gets or sets the user interface for the Foreach enumerator object.

public:
 property System::String ^ UITypeName { System::String ^ get(); void set(System::String ^ value); };
public string UITypeName { get; set; }
member this.UITypeName : string with get, set
Public Property UITypeName As String

Property Value

The type name of the user interface of the Foreach enumerator object.

Examples

The following code sample shows the attribute applied to a new class, with several properties defined, including the DisplayName, Description, ForEachEnumeratorContact, and UITypeName.

using System;  
using Microsoft.SqlServer.Dts.Runtime;  

namespace Microsoft.Samples.SqlServer.Dts  
{  
// This attribute marks the class as a managed ForEachEnumerator.  
    [DtsForEachEnumerator(DisplayName = "MyEnumerator",  
      Description="A managed enumerator",  
      UITypeName="<FullyQualifiedTypeName>",  
      ForEachEnumeratorContact="Name of company to contact")]  
    public class MyEnumerator : ForEachEnumerator  
    {  
        // Insert your enumerator code here.  
    }  
}  
Imports System  
Imports Microsoft.SqlServer.Dts.Runtime  

Namespace Microsoft.Samples.SqlServer.Dts  
  ' This attribute marks the class as a managed ForEachEnumerator.  
  <DtsForEachEnumerator(DisplayName:="MyEnumerator", _  
    Description:="A managed enumerator", _  
    UITypeName:="<FullyQualifiedTypeName>", _  
    ForEachEnumeratorContact:="Name of company to contact")> _  
  Public Class MyEnumerator  
    Inherits ForEachEnumerator  
    ' Insert your enumerator code here.  
  End Class  
End Namespace  

Remarks

This optional property specifies the user interface that is displayed when the ForEach enumerator object is edited in the SQL Server SQL Server Data Tools (SSDT).

Applies to