DtsForEachEnumeratorAttribute クラス

ForEachEnumerator オブジェクトに関するデザイン時の情報を提供します。このクラスは継承できません。

名前空間:  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

説明

この属性は、すべてのマネージ Foreach 列挙子クラスに適用され、そのクラスを SQL Server (SSIS) ランタイム エンジンへのマネージ Foreach 列挙子として識別します。この属性は、そのプロパティを介して情報を提供し、デザイナのオブジェクトの表示方法およびオブジェクトとの連携方法を制御します。すべてのマネージ列挙子は ForEachEnumerator 基本クラスから派生するため、カスタム列挙子を作成するには、最初にクラス ライブラリ プロジェクトを作成し、基本クラスから継承します。次に、DtsForEachEnumeratorAttribute をクラスに適用します。この属性は、デザイナに名前、説明、およびユーザー インターフェイスのデザイン時の情報を提供します。UITypeName プロパティは、ForEachLoop エディタで表示される列挙子のユーザー インターフェイスを実装する Type を識別します。DisplayName プロパティは、SQL ServerBusiness Intelligence Development Studio のツールボックスで表示されます。

クラスへの属性の適用の詳細については、『.NET Framework 開発者ガイド』の「属性の適用」を参照してください。

属性は、UITypeNameForEachEnumeratorContact などの DtsForEachEnumeratorAttribute で宣言される他の属性に加えて、Attributes クラスからの次の要素を含むことができるコンマ区切り文字列として書式設定されます。

  • 種類名

  • アセンブリ名

  • ファイル バージョン

  • カルチャ

  • パブリック キー トークン

次の文字列では、文字列の書式設定方法の一例を示します。

[DtsForEachEnumerator(DisplayName="MyEnumerator",UITypeName="MyNamespace.MyEnumeratorClassName,MyAssemblyName,Version=1.0.0.0,Culture=neutral,PublicKeyToken=<value>")]

グローバル アセンブリ キャッシュ (GAC) のアセンブリのプロパティを調べると、アセンブリに Culture パラメータおよび PublicKeyToken パラメータの値が見つかります。

使用例

次のコード サンプルでは、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

継承階層

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

スレッド セーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。