DtsForEachEnumeratorAttribute 类

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

继承层次结构

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

命名空间：  Microsoft.SqlServer.Dts.Runtime
程序集：  Microsoft.SqlServer.ManagedDTS（在 Microsoft.SqlServer.ManagedDTS.dll 中）

语法

声明
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := False, AllowMultiple := False)> _
Public NotInheritable Class DtsForEachEnumeratorAttribute _
    Inherits DtsLocalizableAttribute
用法
Dim instance As DtsForEachEnumeratorAttribute

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

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

[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = false)>]
type DtsForEachEnumeratorAttribute =  
    class
        inherit DtsLocalizableAttribute
    end

public final class DtsForEachEnumeratorAttribute extends DtsLocalizableAttribute

DtsForEachEnumeratorAttribute 类型公开以下成员。

构造函数

	名称	说明
	DtsForEachEnumeratorAttribute	Initializes a new instance of the DtsForEachEnumeratorAttribute.

页首

属性

	名称	说明
	Description	基础结构。 （从 DtsLocalizableAttribute 继承。）
	DisplayName	基础结构。 （从 DtsLocalizableAttribute 继承。）
	ForEachEnumeratorContact	Gets or sets the contact information for the Foreach enumerator object.
	LocalizationType	基础结构。 （从 DtsLocalizableAttribute 继承。）
	TypeId	（从 Attribute 继承。）
	UITypeName	Gets or sets the user interface for the Foreach enumerator object.

页首

方法

	名称	说明
	Equals	（从 Attribute 继承。）
	Finalize	（从 Object 继承。）
	GetHashCode	（从 Attribute 继承。）
	GetType	（从 Object 继承。）
	IsDefaultAttribute	（从 Attribute 继承。）
	Match	（从 Attribute 继承。）
	MemberwiseClone	（从 Object 继承。）
	ToString	（从 Object 继承。）

页首

显式接口实现

	名称	说明
	_Attribute. . :: . .GetIDsOfNames	（从 Attribute 继承。）
	_Attribute. . :: . .GetTypeInfo	（从 Attribute 继承。）
	_Attribute. . :: . .GetTypeInfoCount	（从 Attribute 继承。）
	_Attribute. . :: . .Invoke	（从 Attribute 继承。）

页首

注释

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 Business Intelligence Development Studio.

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.0.0.0,Culture=neutral,PublicKeyToken=<value>")]

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

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

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Dts.Runtime 命名空间