Cet article a fait l'objet d'une traduction manuelle. Déplacez votre pointeur sur les phrases de l'article pour voir la version originale de ce texte. |
Traduction
Source
|
CustomAttributeData, classe
Fournit un accès aux données d'attribut personnalisé pour les assemblys, les modules, les types, les membres et les paramètres qui sont chargés dans le contexte de réflexion uniquement.
Assembly : mscorlib (dans mscorlib.dll)
Le type CustomAttributeData expose les membres suivants.
| Nom | Description | |
|---|---|---|
|
CustomAttributeData | Initialise une nouvelle instance de la classe CustomAttributeData. |
| Nom | Description | |
|---|---|---|
|
Constructor | Retourne un objet ConstructorInfo représentant le constructeur qui aurait initialisé l'attribut personnalisé. |
|
ConstructorArguments | Obtient la liste d'arguments de position spécifiés pour l'instance d'attribut représentée par l'objet CustomAttributeData. |
|
NamedArguments | Obtient la liste d'arguments nommés spécifiés pour l'instance d'attribut représentée par l'objet CustomAttributeData. |
| Nom | Description | |
|---|---|---|
|
Equals | 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 netto***ge avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.) |
|
GetCustomAttributes(Assembly) | Retourne une liste d'objets CustomAttributeData représentant des données relatives aux attributs qui ont été appliqués à l'assembly cible. |
|
GetCustomAttributes(MemberInfo) | Retourne une liste d'objets CustomAttributeData représentant des données relatives aux attributs qui ont été appliqués au membre cible. |
|
GetCustomAttributes(Module) | Retourne une liste d'objets CustomAttributeData représentant des données relatives aux attributs qui ont été appliqués au module cible. |
|
GetCustomAttributes(ParameterInfo) | Retourne une liste d'objets CustomAttributeData représentant des données relatives aux attributs qui ont été appliqués au paramètre cible. |
|
GetHashCode | Sert de fonction de hachage pour un type particulier. (Substitue Object.GetHashCode().) |
|
GetType | Obtient le Type de l'instance actuelle. (Hérité de Object.) |
|
MemberwiseClone | Crée une copie superficielle de l'objet Object actif. (Hérité de Object.) |
|
ToString | Retourne une représentation sous forme de chaîne de l'attribut personnalisé. (Substitue Object.ToString().) |
Le code qui est examiné dans le contexte de réflexion uniquement ne peut pas être exécuté ; il n'est par conséquent pas toujours possible d'examiner des attributs personnalisés en en créant des instances et en examinant ensuite leurs propriétés à l'aide de méthodes telles que Attribute.GetCustomAttributes, MemberInfo.GetCustomAttributes, et ainsi de suite. Si le code pour le type d'attribut lui-même est chargé dans le contexte de réflexion uniquement, il ne peut pas être exécuté.
La classe CustomAttributeData permet d'effectuer un examen des attributs personnalisés dans le contexte de réflexion uniquement en fournissant une abstraction pour les attributs. Les membres de cette classe peuvent être utilisés pour obtenir les arguments de position et les arguments nommés de l'attribut. Utilisez la propriété ConstructorArguments pour obtenir une liste de structures CustomAttributeTypedArgument qui représentent les arguments de position et la propriété NamedArguments pour obtenir une liste de structures CustomAttributeNamedArgument qui représentent les arguments nommés.
Remarque
|
|---|
|
La structure CustomAttributeNamedArgument fournit uniquement des informations sur la propriété d'attribut utilisée pour obtenir et définir la valeur d'argument. Pour obtenir le type et la valeur de l'argument, utilisez la propriété CustomAttributeNamedArgument.TypedValue afin d'avoir une structure CustomAttributeTypedArgument. |
Lorsque vous avez une structure CustomAttributeTypedArgument pour un argument, qu'il s'agisse d'un argument nommé ou de position, utilisez la propriété CustomAttributeTypedArgument.ArgumentType pour obtenir le type et la propriété CustomAttributeTypedArgument.Value afin d'obtenir la valeur.
Remarque
|
|---|
|
Pour un argument de tableau, la propriété CustomAttributeTypedArgument.Value retourne un ReadOnlyCollection<T> générique d'objets CustomAttributeTypedArgument. Chaque objet CustomAttributeTypedArgument contenu dans la collection représente l'élément correspondant du tableau. |
CustomAttributeData peut être utilisé dans le contexte d'exécution aussi bien que dans le contexte de réflexion uniquement. Par exemple, vous souhaiterez peut-être éviter de charger l'assembly qui contient le code d'un attribut personnalisé. L'utilisation de la classe CustomAttributeData diffère de celle de méthodes telles que Attribute.GetCustomAttributes :
-
Les propriétés et méthodes de CustomAttributeData ne vous fournissent que les valeurs qui ont été spécifiées pour l'instance d'attribut, et non la sémantique du constructeur. Par exemple, un argument de chaîne d'un attribut peut être converti en interne en une autre représentation, puis retourné sous forme canonique ; ou une propriété peut avoir des effets secondaires lorsque le code d'attribut réel est exécuté.
-
Les propriétés et méthodes de CustomAttributeData ne vous permettent pas de récupérer les attributs personnalisés hérités de classes de base.
Pour créer des instances de la classe CustomAttributeData, utilisez les méthodes de fabrique static (Shared en Visual Basic) GetCustomAttributes.
Dans l'exemple suivant, un attribut personnalisé est défini avec quatre constructeurs et quatre propriétés. Deux des propriétés sont en lecture seule et sont définies à l'aide des paramètres positionnels des constructeurs. Les deux autres propriétés sont en lecture/écriture et ne peuvent être définies qu'à l'aide d'arguments nommés. Une propriété positionnelle est un tableau de chaînes, alors qu'une propriété nommée est un tableau d'entiers.
L'attribut est appliqué à l'assembly, à un type déclaré dans l'assembly, à une méthode du type et à un paramètre de la méthode. Différents constructeurs sont utilisés dans ces cas. Lorsqu'il est exécuté, l'assembly se charge dans le contexte de réflexion uniquement et affiche des informations sur les attributs personnalisés qui ont été appliqués à l'assembly et au type et aux membres qu'il contient.
L'attribut appliqué au type présente des propriétés de tableau, avec à la fois des arguments positionnels et des arguments nommés.
using System; using System.Reflection; using System.Collections.Generic; using System.Collections.ObjectModel; // The example attribute is applied to the assembly. [assembly:Example(ExampleKind.ThirdKind, Note="This is a note on the assembly.")] // An enumeration used by the ExampleAttribute class. public enum ExampleKind { FirstKind, SecondKind, ThirdKind, FourthKind }; // An example attribute. The attribute can be applied to all // targets, from assemblies to parameters. // [AttributeUsage(AttributeTargets.All)] public class ExampleAttribute : Attribute { // Data for properties. private ExampleKind kindValue; private string noteValue; private string[] arrayStrings; private int[] arrayNumbers; // Constructors. The parameterless constructor (.ctor) calls // the constructor that specifies ExampleKind and an array of // strings, and supplies the default values. // public ExampleAttribute(ExampleKind initKind, string[] initStrings) { kindValue = initKind; arrayStrings = initStrings; } public ExampleAttribute(ExampleKind initKind) : this(initKind, null) {} public ExampleAttribute() : this(ExampleKind.FirstKind, null) {} // Properties. The Note and Numbers properties must be read/write, so they // can be used as named parameters. // public ExampleKind Kind { get { return kindValue; }} public string[] Strings { get { return arrayStrings; }} public string Note { get { return noteValue; } set { noteValue = value; } } public int[] Numbers { get { return arrayNumbers; } set { arrayNumbers = value; } } } // The example attribute is applied to the test class. // [Example(ExampleKind.SecondKind, new string[] { "String array argument, line 1", "String array argument, line 2", "String array argument, line 3" }, Note="This is a note on the class.", Numbers = new int[] { 53, 57, 59 })] public class Test { // The example attribute is applied to a method, using the // parameterless constructor and supplying a named argument. // The attribute is also applied to the method parameter. // [Example(Note="This is a note on a method.")] public void TestMethod([Example] object arg) { } // Main() gets objects representing the assembly, the test // type, the test method, and the method parameter. Custom // attribute data is displayed for each of these. // public static void Main() { Assembly asm = Assembly.ReflectionOnlyLoad("Source"); Type t = asm.GetType("Test"); MethodInfo m = t.GetMethod("TestMethod"); ParameterInfo[] p = m.GetParameters(); Console.WriteLine("\r\nAttributes for assembly: '{0}'", asm); ShowAttributeData(CustomAttributeData.GetCustomAttributes(asm)); Console.WriteLine("\r\nAttributes for type: '{0}'", t); ShowAttributeData(CustomAttributeData.GetCustomAttributes(t)); Console.WriteLine("\r\nAttributes for member: '{0}'", m); ShowAttributeData(CustomAttributeData.GetCustomAttributes(m)); Console.WriteLine("\r\nAttributes for parameter: '{0}'", p); ShowAttributeData(CustomAttributeData.GetCustomAttributes(p[0])); } private static void ShowAttributeData( IList<CustomAttributeData> attributes) { foreach( CustomAttributeData cad in attributes ) { Console.WriteLine(" {0}", cad); Console.WriteLine(" Constructor: '{0}'", cad.Constructor); Console.WriteLine(" Constructor arguments:"); foreach( CustomAttributeTypedArgument cata in cad.ConstructorArguments ) { ShowValueOrArray(cata); } Console.WriteLine(" Named arguments:"); foreach( CustomAttributeNamedArgument cana in cad.NamedArguments ) { Console.WriteLine(" MemberInfo: '{0}'", cana.MemberInfo); ShowValueOrArray(cana.TypedValue); } } } private static void ShowValueOrArray(CustomAttributeTypedArgument cata) { if (cata.Value.GetType() == typeof(ReadOnlyCollection<CustomAttributeTypedArgument>)) { Console.WriteLine(" Array of '{0}':", cata.ArgumentType); foreach (CustomAttributeTypedArgument cataElement in (ReadOnlyCollection<CustomAttributeTypedArgument>) cata.Value) { Console.WriteLine(" Type: '{0}' Value: '{1}'", cataElement.ArgumentType, cataElement.Value); } } else { Console.WriteLine(" Type: '{0}' Value: '{1}'", cata.ArgumentType, cata.Value); } } } /* This code example produces output similar to the following: Attributes for assembly: 'source, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null' [System.Runtime.CompilerServices.CompilationRelaxationsAttribute((Int32)8)] Constructor: 'Void .ctor(Int32)' Constructor arguments: Type: 'System.Int32' Value: '8' Named arguments: [System.Runtime.CompilerServices.RuntimeCompatibilityAttribute(WrapNonExceptionThrows = True)] Constructor: 'Void .ctor()' Constructor arguments: Named arguments: MemberInfo: 'Boolean WrapNonExceptionThrows' Type: 'System.Boolean' Value: 'True' [ExampleAttribute((ExampleKind)2, Note = "This is a note on the assembly.")] Constructor: 'Void .ctor(ExampleKind)' Constructor arguments: Type: 'ExampleKind' Value: '2' Named arguments: MemberInfo: 'System.String Note' Type: 'System.String' Value: 'This is a note on the assembly.' Attributes for type: 'Test' [ExampleAttribute((ExampleKind)1, new String[3] { "String array argument, line 1", "String array argument, line 2", "String array argument, line 3" }, Note = "This is a note on the class.", Numbers = new Int32[3] { 53, 57, 59 })] Constructor: 'Void .ctor(ExampleKind, System.String[])' Constructor arguments: Type: 'ExampleKind' Value: '1' Array of 'System.String[]': Type: 'System.String' Value: 'String array argument, line 1' Type: 'System.String' Value: 'String array argument, line 2' Type: 'System.String' Value: 'String array argument, line 3' Named arguments: MemberInfo: 'System.String Note' Type: 'System.String' Value: 'This is a note on the class.' MemberInfo: 'Int32[] Numbers' Array of 'System.Int32[]': Type: 'System.Int32' Value: '53' Type: 'System.Int32' Value: '57' Type: 'System.Int32' Value: '59' Attributes for member: 'Void TestMethod(System.Object)' [ExampleAttribute(Note = "This is a note on a method.")] Constructor: 'Void .ctor()' Constructor arguments: Named arguments: MemberInfo: 'System.String Note' Type: 'System.String' Value: 'This is a note on a method.' Attributes for parameter: 'System.Object arg' [ExampleAttribute()] Constructor: 'Void .ctor()' Constructor arguments: Named arguments: */
Windows 7, Windows Vista SP1 ou ultérieur, Windows XP SP3, Windows XP SP2 Édition x64, Windows Server 2008 (installation minimale non prise en charge), Windows Server 2008 R2 (installation minimale prise en charge avec SP1 ou version ultérieure), Windows Server 2003 SP2
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.
Remarque