Classe DtsForEachEnumeratorAttribute

Hiérarchie d'héritage

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

Syntaxe

'Déclaration
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := False, AllowMultiple := False)> _
Public NotInheritable Class DtsForEachEnumeratorAttribute _
    Inherits DtsLocalizableAttribute
'Utilisation
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

Constructeurs

	Nom	Description
	DtsForEachEnumeratorAttribute	Initializes a new instance of the DtsForEachEnumeratorAttribute.

Haut de la page

Propriétés

	Nom	Description
	Description	Infrastructure. (hérité de DtsLocalizableAttribute.)
	DisplayName	Infrastructure. (hérité de DtsLocalizableAttribute.)
	ForEachEnumeratorContact	Gets or sets the contact information for the Foreach enumerator object.
	LocalizationType	Infrastructure. (hérité de DtsLocalizableAttribute.)
	TypeId	(hérité de Attribute.)
	UITypeName	Gets or sets the user interface for the Foreach enumerator object.

Haut de la page

Méthodes

	Nom	Description
	Equals	(hérité de Attribute.)
	Finalize	(hérité de Object.)
	GetHashCode	(hérité de Attribute.)
	GetType	(hérité de Object.)
	IsDefaultAttribute	(hérité de Attribute.)
	Match	(hérité de Attribute.)
	MemberwiseClone	(hérité de Object.)
	ToString	(hérité de Object.)

Haut de la page

Implémentations d'interfaces explicites

	Nom	Description
	_Attribute. . :: . .GetIDsOfNames	(hérité de Attribute.)
	_Attribute. . :: . .GetTypeInfo	(hérité de Attribute.)
	_Attribute. . :: . .GetTypeInfoCount	(hérité de Attribute.)
	_Attribute. . :: . .Invoke	(hérité de Attribute.)

Haut de la page

Notes

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

Exemples

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

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence