Share via

  • Article

DtsForEachEnumeratorAttribute.UITypeName Property

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

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

Syntax

'Declaration
Public Property UITypeName As String
    Get
    Set
'Usage
Dim instance As DtsForEachEnumeratorAttribute
Dim value As String

value = instance.UITypeName

instance.UITypeName = value

public string UITypeName { get; set; }

public:
property String^ UITypeName {
    String^ get ();
    void set (String^ value);
}

member UITypeName : string with get, set

function get UITypeName () : String
function set UITypeName (value : String)

Property Value

Type: System.String
The type name of the user interface of the Foreach enumerator object.

Remarks

This optional property specifies the user interface that is displayed when the ForEach enumerator object is edited in the SQL Server Business Intelligence Development Studio.

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