DtsForEachEnumeratorAttribute 类

定义

提供有关 ForEachEnumerator 对象的设计时信息。 此类不能被继承。

public ref class DtsForEachEnumeratorAttribute sealed : Microsoft::SqlServer::Dts::Runtime::Localization::DtsLocalizableAttribute
[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=false)]
public sealed class DtsForEachEnumeratorAttribute : Microsoft.SqlServer.Dts.Runtime.Localization.DtsLocalizableAttribute
[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=false)>]
type DtsForEachEnumeratorAttribute = class
    inherit DtsLocalizableAttribute
Public NotInheritable Class DtsForEachEnumeratorAttribute
Inherits DtsLocalizableAttribute
继承
DtsForEachEnumeratorAttribute
属性

示例

下面的代码示例显示了应用于新类的属性,其中定义了多个属性,包括 DisplayNameDescriptionForEachEnumeratorContactUITypeName

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  

注解

此属性应用于所有托管Foreach枚举器类,并将该类标识为SQL Server (SSIS) 运行时引擎的托管Foreach枚举器。 此属性通过其属性提供信息,以控制设计器如何显示和与对象交互。 由于所有托管枚举器都派生自 ForEachEnumerator 基类,因此创建自定义枚举器的第一步是创建类库项目并从基类继承。 接下来,将 DtsForEachEnumeratorAttribute 类应用到该类。 此属性向设计器提供名称、说明和用户界面设计时信息。 该 UITypeName 属性标识 Type 为编辑器中显示的 ForEachLoop 枚举器实现用户界面。 该DisplayName属性显示在 SSDT) SQL Server SQL Server Data Tools (工具箱中。

有关将属性应用于类的详细信息,请参阅.NET Framework开发人员指南中的“应用属性”。

该属性的格式设置为逗号分隔的字符串,该字符串可以包含类中的以下元素 Attributes ,除了在类上 DtsForEachEnumeratorAttribute声明的其他属性(如 UITypeNameForEachEnumeratorContact

  • 类型名称

  • 程序集名称

  • 文件版本

  • 环境

  • 公钥标记

以下字符串提供了如何设置字符串格式的示例。

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

可以通过检查全局程序集缓存中程序集的属性 (GAC) 来查找 Culture 程序集的值和 PublicKeyToken 参数。

构造函数

DtsForEachEnumeratorAttribute()

初始化 DtsForEachEnumeratorAttribute 的新实例。

属性

Description

获取或设置 DtsLocalizableAttribute 的说明。

(继承自 DtsLocalizableAttribute)
DisplayName

获取或设置 DtsLocalizableAttribute 的显示名称。

(继承自 DtsLocalizableAttribute)
ForEachEnumeratorContact

获取或设置 Foreach 枚举器对象的联系信息。

LocalizationType

获取或设置为 DtsLocalizableAttribute 提供值的类。

(继承自 DtsLocalizableAttribute)
UITypeName

获取或设置 Foreach 枚举器对象的用户界面。

适用于