DtsForEachEnumeratorAttribute Classe

Définition

Fournit des informations sur un objet ForEachEnumerator au moment de la conception. Cette classe ne peut pas être héritée.

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
Héritage
DtsForEachEnumeratorAttribute
Attributs

Exemples

L’exemple de code suivant montre l’attribut appliqué à une nouvelle classe, avec plusieurs propriétés définies, notamment le DisplayName, Description, et ForEachEnumeratorContactUITypeName.

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  

Remarques

Cet attribut est appliqué à toutes les classes d’énumérateur managés et identifie la classe en tant qu’énumérateur managé ForeachForeach au moteur d’exécution SQL Server (SSIS). Cet attribut fournit des informations via ses propriétés pour contrôler l’affichage et l’interaction du concepteur avec l’objet. Étant donné que tous les énumérateurs managés dérivent de la classe de base, la première étape lors de la ForEachEnumerator création d’un énumérateur personnalisé consiste à créer un projet de bibliothèque de classes et à hériter de la classe de base. Ensuite, appliquez-le DtsForEachEnumeratorAttribute à la classe. Cet attribut fournit le nom, la description et les informations de conception de l’interface utilisateur au concepteur. La UITypeName propriété identifie l’interface Type utilisateur pour l’énumérateur affiché dans l’éditeur ForEachLoop . La DisplayName propriété s’affiche dans la boîte à outils dans le SQL Server SQL Server Data Tools (SSDT).

Pour plus d’informations sur l’application d’attributs à une classe, consultez « Application d’attributs » dans le Guide du développeur .NET Framework.

L’attribut est mis en forme comme chaîne délimitée par des virgules, qui peut contenir les éléments suivants de la Attributes classe, en plus des autres attributs déclarés sur le DtsForEachEnumeratorAttribute, comme le et les ForEachEnumeratorContactUITypeName :

  • Nom de type

  • Nom de l'assembly

  • Version de fichier

  • Culture

  • Jeton de clé publique

La chaîne suivante donne un exemple de mise en forme de la chaîne.

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

Vous trouverez les valeurs des Culture paramètres et PublicKeyToken des valeurs de votre assembly en examinant les propriétés de l’assembly dans le Global Assembly Cache (GAC).

Constructeurs

DtsForEachEnumeratorAttribute()

Initialise une nouvelle instance de l'objet DtsForEachEnumeratorAttribute.

Propriétés

Description

Obtient ou définit la description du DtsLocalizableAttribute.

(Hérité de DtsLocalizableAttribute)
DisplayName

Obtient ou définit le nom complet de l'objet DtsLocalizableAttribute.

(Hérité de DtsLocalizableAttribute)
ForEachEnumeratorContact

Obtient ou définit les informations de contact de l’objet énumérateur Foreach.

LocalizationType

Obtient ou définit la classe qui fournit des valeurs pour l'objet DtsLocalizableAttribute.

(Hérité de DtsLocalizableAttribute)
UITypeName

Obtient ou définit l’interface utilisateur de l’objet énumérateur Foreach.

S’applique à