Cet article a fait l'objet d'une traduction automatique. Déplacez votre pointeur sur les phrases de l'article pour voir la version originale de ce texte. Informations supplémentaires.

Traduction

Source

Ce sujet n'a pas encore été évalué - Évaluez ce sujet

Attribute, classe

.NET Framework 4.5

Autres versions

Représente la classe de base pour les attributs personnalisés.

Hiérarchie d'héritage

System.Object
System.Attribute
En savoir plus...

Espace de noms : System
Assembly : mscorlib (dans mscorlib.dll)

Syntaxe

C++

[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[ComVisibleAttribute(true)]
[AttributeUsageAttribute(AttributeTargets.All, Inherited = true, AllowMultiple = false)]
public abstract class Attribute : _Attribute

Le type Attribute expose les membres suivants.

Constructeurs

	Nom	Description
	Attribute	Initialise une nouvelle instance de la classe Attribute.

Début

Propriétés

	Nom	Description
	TypeId	Lors de son implémentation dans une classe dérivée, obtient un identificateur unique pour Attribute.

Début

Méthodes

	Nom	Description
	Equals	Infrastructure. Retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Substitue Object.Equals(Object).)
	Finalize	Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
	GetCustomAttribute(Assembly, Type)	Récupère un attribut personnalisé appliqué à un assembly spécifié. Les paramètres spécifient l'assembly et le type de l'attribut personnalisé à rechercher.
	GetCustomAttribute(MemberInfo, Type)	Récupère un attribut personnalisé appliqué à un membre d'un type. Les paramètres spécifient le membre, et le type de l'attribut personnalisé à rechercher.
	GetCustomAttribute(Module, Type)	Récupère un attribut personnalisé appliqué à un module. Les paramètres spécifient le module, et le type de l'attribut personnalisé à rechercher.
	GetCustomAttribute(ParameterInfo, Type)	Récupère un attribut personnalisé appliqué à un paramètre de méthode. Les paramètres spécifient le paramètre de méthode et le type de l'attribut personnalisé à rechercher.
	GetCustomAttribute(Assembly, Type, Boolean)	Récupère un attribut personnalisé appliqué à un assembly. Les paramètres spécifient l'assembly, le type de l'attribut personnalisé à rechercher, et une option de recherche ignorée.
	GetCustomAttribute(MemberInfo, Type, Boolean)	Récupère un attribut personnalisé appliqué à un membre d'un type. Les paramètres spécifient le membre, le type de l'attribut personnalisé à rechercher, et la recherche éventuelle des ancêtres du membre.
	GetCustomAttribute(Module, Type, Boolean)	Récupère un attribut personnalisé appliqué à un module. Les paramètres spécifient le module, le type de l'attribut personnalisé à rechercher, et une option de recherche ignorée.
	GetCustomAttribute(ParameterInfo, Type, Boolean)	Récupère un attribut personnalisé appliqué à un paramètre de méthode. Les paramètres spécifient le paramètre de méthode, le type de l'attribut personnalisé à rechercher, et la recherche éventuelle des ancêtres du paramètre de méthode.
	GetCustomAttributes(Assembly)	Récupère le tableau des attributs personnalisés appliqué à un assembly. Un paramètre spécifie l'assembly.
	GetCustomAttributes(MemberInfo)	Récupère le tableau des attributs personnalisés appliqué à un membre d'un type. Un paramètre spécifie le membre.
	GetCustomAttributes(Module)	Récupère le tableau des attributs personnalisés appliqué à un module. Un paramètre spécifie le module.
	GetCustomAttributes(ParameterInfo)	Récupère le tableau des attributs personnalisés appliqué à un paramètre de méthode. Un paramètre spécifie le paramètre de méthode.
	GetCustomAttributes(Assembly, Boolean)	Récupère le tableau des attributs personnalisés appliqué à un assembly. Les paramètres spécifient l'assembly, et une option de recherche ignorée.
	GetCustomAttributes(Assembly, Type)	Récupère le tableau des attributs personnalisés appliqué à un assembly. Les paramètres spécifient l'assembly et le type de l'attribut personnalisé à rechercher.
	GetCustomAttributes(MemberInfo, Boolean)	Récupère le tableau des attributs personnalisés appliqué à un membre d'un type. Les paramètres spécifient le membre, le type de l'attribut personnalisé à rechercher, et la recherche éventuelle des ancêtres du membre.
	GetCustomAttributes(MemberInfo, Type)	Récupère le tableau des attributs personnalisés appliqué à un membre d'un type. Les paramètres spécifient le membre, et le type de l'attribut personnalisé à rechercher.
	GetCustomAttributes(Module, Boolean)	Récupère le tableau des attributs personnalisés appliqué à un module. Les paramètres spécifient le module et une option de recherche ignorée.
	GetCustomAttributes(Module, Type)	Récupère le tableau des attributs personnalisés appliqué à un module. Les paramètres spécifient le module, et le type de l'attribut personnalisé à rechercher.
	GetCustomAttributes(ParameterInfo, Boolean)	Récupère le tableau des attributs personnalisés appliqué à un paramètre de méthode. Les paramètres spécifient le paramètre de méthode et indiquent s'il faut rechercher les ancêtres du paramètre de méthode.
	GetCustomAttributes(ParameterInfo, Type)	Récupère le tableau des attributs personnalisés appliqué à un paramètre de méthode. Les paramètres spécifient le paramètre de méthode et le type de l'attribut personnalisé à rechercher.
	GetCustomAttributes(Assembly, Type, Boolean)	Récupère le tableau des attributs personnalisés appliqué à un assembly. Les paramètres spécifient l'assembly, le type de l'attribut personnalisé à rechercher, et une option de recherche ignorée.
	GetCustomAttributes(MemberInfo, Type, Boolean)	Récupère le tableau des attributs personnalisés appliqué à un membre d'un type. Les paramètres spécifient le membre, le type de l'attribut personnalisé à rechercher, et la recherche éventuelle des ancêtres du membre.
	GetCustomAttributes(Module, Type, Boolean)	Récupère le tableau des attributs personnalisés appliqué à un module. Les paramètres spécifient le module, le type de l'attribut personnalisé à rechercher, et une option de recherche ignorée.
	GetCustomAttributes(ParameterInfo, Type, Boolean)	Récupère le tableau des attributs personnalisés appliqué à un paramètre de méthode. Les paramètres spécifient le paramètre de méthode, le type de l'attribut personnalisé à rechercher, et la recherche éventuelle des ancêtres du paramètre de méthode.
	GetHashCode	Retourne le code de hachage de cette instance. (Substitue Object.GetHashCode().)
	GetType	Obtient le Type de l'instance actuelle. (Hérité de Object.)
	IsDefaultAttribute	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée.
	IsDefined(Assembly, Type)	Détermine si des attributs personnalisés sont appliqués à un assembly. Les paramètres spécifient l'assembly et le type de l'attribut personnalisé à rechercher.
	IsDefined(MemberInfo, Type)	Détermine si des attributs personnalisés sont appliqués à un membre d'un type. Les paramètres spécifient le membre, et le type de l'attribut personnalisé à rechercher.
	IsDefined(Module, Type)	Détermine si des attributs personnalisés d'un type spécifié sont appliqués à un module. Les paramètres spécifient le module, et le type de l'attribut personnalisé à rechercher.
	IsDefined(ParameterInfo, Type)	Détermine si des attributs personnalisés sont appliqués à un paramètre de méthode. Les paramètres spécifient le paramètre de méthode et le type de l'attribut personnalisé à rechercher.
	IsDefined(Assembly, Type, Boolean)	Détermine si des attributs personnalisés sont appliqués à un assembly. Les paramètres spécifient l'assembly, le type de l'attribut personnalisé à rechercher, et une option de recherche ignorée.
	IsDefined(MemberInfo, Type, Boolean)	Détermine si des attributs personnalisés sont appliqués à un membre d'un type. Les paramètres spécifient le membre, le type de l'attribut personnalisé à rechercher, et la recherche éventuelle des ancêtres du membre.
	IsDefined(Module, Type, Boolean)	Détermine si des attributs personnalisés sont appliqués à un module. Les paramètres spécifient le module, le type de l'attribut personnalisé à rechercher, et une option de recherche ignorée.
	IsDefined(ParameterInfo, Type, Boolean)	Détermine si des attributs personnalisés sont appliqués à un paramètre de méthode. Les paramètres spécifient le paramètre de méthode, le type de l'attribut personnalisé à rechercher, et la recherche éventuelle des ancêtres du paramètre de méthode.
	Match	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.
	MemberwiseClone	Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
	ToString	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)

Début

Implémentations d'interface explicite

	Nom	Description
	_Attribute.GetIDsOfNames	Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.
	_Attribute.GetTypeInfo	Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface.
	_Attribute.GetTypeInfoCount	Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).
	_Attribute.Invoke	Fournit l'accès aux propriétés et aux méthodes exposées par un objet.

Début

Notes

La classe Attribute associe les informations système prédéfinies ou les informations personnalisées, définies par l'utilisateur, à un élément cible. Un assembly, une classe, un constructeur, un délégué, une énumération, un événement, un champ, une interface, une méthode, un module de fichier exécutable portable, un paramètre, une propriété, une valeur de retour, une structure ou un autre attribut sont autant d'exemples d'élément cible.

Les informations fournies par un attribut sont également désignées par le terme « métadonnées ». L'application peut examiner les métadonnées au moment de l'exécution pour contrôler la façon dont le programme traite des données, ou avant l'exécution par des outils externes pour contrôler la façon dont l'application elle-même est traitée ou gérée. Par exemple, le .NET Framework prédéfinit et utilise des types d'attributs pour contrôler le comportement au moment de l'exécution, et certains langages de programmation utilisent des types d'attributs pour représenter des fonctionnalités du langage qui ne sont pas directement prises en charge par le système de type commun (CTS, Common Type System) du .NET Framework.

Tous les attributs sont directement ou indirectement dérivés de la classe Attribute. Les attributs peuvent être appliqués à n'importe quel élément cible, plusieurs attributs peuvent être appliqués au même élément cible et les attributs peuvent être hérités par un élément dérivé d'un élément cible. Utilisez la classe AttributeTargets pour spécifier l'élément cible auquel l'attribut est appliqué.

La classe Attribute propose des méthodes utiles pour récupérer les attributs personnalisés et les tester. Pour plus d'informations sur l'utilisation des attributs, consultez Application des attributs et Extension des métadonnées à l'aide des attributs.

Exemples

L'exemple de code suivant illustre l'utilisation de Attribute.

C++


using System;
using System.Reflection;

// An enumeration of animals. Start at 1 (0 = uninitialized).
public enum Animal {
    // Pets.
    Dog = 1,
    Cat,
    Bird,
}

// A custom attribute to allow a target to have a pet.
public class AnimalTypeAttribute : Attribute {
    // The constructor is called when the attribute is set.
    public AnimalTypeAttribute(Animal pet) {
        thePet = pet;
    }

    // Keep a variable internally ...
    protected Animal thePet;

    // .. and show a copy to the outside world.
    public Animal Pet {
        get { return thePet; }
        set { thePet = value; }
    }
}

// A test class where each method has its own pet.
class AnimalTypeTestClass {
    [AnimalType(Animal.Dog)]
    public void DogMethod() {}

    [AnimalType(Animal.Cat)]
    public void CatMethod() {}

    [AnimalType(Animal.Bird)]
    public void BirdMethod() {}
}

class DemoClass {
    static void Main(string[] args) {
        AnimalTypeTestClass testClass = new AnimalTypeTestClass();
        Type type = testClass.GetType();
        // Iterate through all the methods of the class.
        foreach(MethodInfo mInfo in type.GetMethods()) {
            // Iterate through all the Attributes for each method.
            foreach (Attribute attr in
                Attribute.GetCustomAttributes(mInfo)) {
                // Check for the AnimalType attribute.
                if (attr.GetType() == typeof(AnimalTypeAttribute))
                    Console.WriteLine(
                        "Method {0} has a pet {1} attribute.",
                        mInfo.Name, ((AnimalTypeAttribute)attr).Pet);
            }

        }
    }
}
/*
 * Output:
 * Method DogMethod has a pet Dog attribute.
 * Method CatMethod has a pet Cat attribute.
 * Method BirdMethod has a pet Bird attribute.
 */

Informations de version

.NET Framework

Pris en charge dans : 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Pris en charge dans : 4, 3.5 SP1

Bibliothèque de classes portable

Pris en charge dans : Bibliothèque de classes portable

.NET pour les applications du Windows Store

Pris en charge dans : Windows 8

Plateformes

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (rôle principal du serveur non pris en charge), Windows Server 2008 R2 (rôle principal du serveur pris en charge avec SP1 ou version ultérieure ; Itanium non pris en charge)

Le .NET Framework ne prend pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.

Sécurité des threads

Ce type est thread-safe.

Voir aussi

Référence

System, espace de noms

Autres ressources

Application des attributs

Extension des métadonnées à l'aide des attributs

Hiérarchie d'héritage

Cela vous a-t-il été utile ? Oui Non

Manque de précision

Pas suffisamment approfondi

Besoin d'exemples de code supplémentaires

La traduction a besoin d'être améliorée.

(1500 caractères restants)

Ajouts de la communauté

AJOUTER

Microsoft réalise une enquête en ligne pour recueillir votre opinion sur le site Web de MSDN. Si vous choisissez d’y participer, cette enquête en ligne vous sera présentée lorsque vous quitterez le site Web de MSDN.

Si vous souhaitez y participer,

Confidentialité