Export (0) Print
Expand All

DtsForEachEnumeratorAttribute Class

Supplies design-time information about a ForEachEnumerator object. This class cannot be inherited.

Object
  Attribute
    Microsoft.SqlServer.Dts.Runtime.Localization.DtsLocalizableAttribute
      Microsoft.SqlServer.Dts.Runtime.DtsForEachEnumeratorAttribute

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

[AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
public sealed class DtsForEachEnumeratorAttribute : DtsLocalizableAttribute

The DtsForEachEnumeratorAttribute type exposes the following members.

  NameDescription
Public methodDtsForEachEnumeratorAttributeInitializes a new instance of the DtsForEachEnumeratorAttribute.
Top

  NameDescription
Public propertyDescriptionInfrastructure. Gets or sets the description of the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
Public propertyDisplayNameInfrastructure. Gets or sets the display name of the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
Public propertyForEachEnumeratorContactGets or sets the contact information for the Foreach enumerator object.
Public propertyLocalizationTypeInfrastructure. Gets or sets the class that supplies values for the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
Public propertyTypeId (Inherited from Attribute.)
Public propertyUITypeNameGets or sets the user interface for the Foreach enumerator object.
Top

  NameDescription
Public methodEquals (Inherited from Attribute.)
Public methodGetHashCode (Inherited from Attribute.)
Public methodGetType (Inherited from Object.)
Public methodIsDefaultAttribute (Inherited from Attribute.)
Public methodMatch (Inherited from Attribute.)
Public methodToString (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodSystem#Runtime#InteropServices#_Attribute#GetIDsOfNames (Inherited from Attribute.)
Explicit interface implemetationPrivate methodSystem#Runtime#InteropServices#_Attribute#GetTypeInfo (Inherited from Attribute.)
Explicit interface implemetationPrivate methodSystem#Runtime#InteropServices#_Attribute#GetTypeInfoCount (Inherited from Attribute.)
Explicit interface implemetationPrivate methodSystem#Runtime#InteropServices#_Attribute#Invoke (Inherited from Attribute.)
Top

This attribute is applied to all managed Foreach enumerator classes and identifies the class as a managed Foreach enumerator to the SQL Server (SSIS) run-time engine. This attribute provides information through its properties to control how the designer displays and interacts with the object. Because all managed enumerators derive from the ForEachEnumerator base class, the first step when creating a custom enumerator is to create a class library project and inherit from the base class. Next, apply the DtsForEachEnumeratorAttribute to the class. This attribute provides the name, description, and user interface design-time information to the designer. The UITypeName property identifies the Type that implements the user interface for the enumerator that is displayed in the ForEachLoop editor. The DisplayName property is displayed in the Toolbox in the SQL Server SQL Server Data Tools (SSDT).

For more information about applying attributes to a class, see "Applying Attributes" in the .NET Framework Developer's Guide.

The attribute is formatted as a comma-delimited string, which can contain the following elements from the Attributes class, in addition to the other attributes declared on the DtsForEachEnumeratorAttribute, such as the UITypeName and the ForEachEnumeratorContact:

  • Type name

  • Assembly name

  • File version

  • Culture

  • Public key token

The following string gives an example of how the string is formatted.

[DtsForEachEnumerator(DisplayName="MyEnumerator",UITypeName="MyNamespace.MyEnumeratorClassName,MyAssemblyName",Version="1.00.000.00",Culture="neutral",PublicKeyToken="")]

You can find the values of the Culture and PublicKeyToken parameters in your assembly by examining the properties of the assembly in the global assembly cache (GAC).

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft