Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / C#

GetCustomAttribute<T> — lire un attribut unique

CustomAttributeExtensions.GetCustomAttribute<T> récupère par réflexion un attribut unique de type T. Découvrez les cibles prises en charge, le traitement de null et pourquoi plusieurs correspondances provoquent une exception.

Version : .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Syntaxe

public static T? GetCustomAttribute<T>(this System.Reflection.MemberInfo element, bool inherit) where T : Attribute;

CustomAttributeExtensions.GetCustomAttribute<T> dans System.Reflection fournit des méthodes d’extension pour MemberInfo, ParameterInfo, Assembly et Module. T peut être System.Attribute lui-même ou un type qui en dérive. L’import using System.Reflection; permet d’écrire element.GetCustomAttribute<T>() ; pour un type, utilisez typeof(Report).

Le résultat est un attribut correspondant de type T, ou null si aucun n’est trouvé. Plusieurs correspondances provoquent AmbiguousMatchException, au lieu de sélectionner le premier résultat. Un appel à GetCustomAttribute<Attribute> est valide et lève lui aussi cette exception si plusieurs attributs correspondent. Si vous vous attendez à plusieurs attributs, utilisez GetCustomAttributes<T>. Si l’argument element vaut null, une ArgumentNullException est levée.

Les surcharges pour MemberInfo et ParameterInfo acceptent également bool inherit. Avec false, la recherche se limite aux attributs appliqués directement à la cible. Avec true, elle tient compte de l’héritage uniquement si la cible le prend en charge. Un paramètre d’une méthode qui redéfinit une méthode de base peut hériter des attributs du paramètre correspondant de cette méthode de base, mais un paramètre de constructeur n’a pas de chaîne d’héritage de ce type. Les attributs marqués Inherited = false ne sont pas hérités. L’exemple limite explicitement la recherche avec inherit: false ; le résultat Monthly provient de LabelAttribute appliqué à Report.

Exemples

using System;
using System.Reflection;

LabelAttribute? label = typeof(Report)
    .GetCustomAttribute<LabelAttribute>(inherit: false);
Console.WriteLine(label?.Text ?? "missing");

[AttributeUsage(AttributeTargets.Class)]
public sealed class LabelAttribute : Attribute
{
    public LabelAttribute(string text) => Text = text;
    public string Text { get; }
}

[Label("Monthly")]
public sealed class Report { }

Résultat

Monthly

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources