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

CKTIS / C#

AttributeUsageAttribute — règles des attributs personnalisés

AttributeUsageAttribute précise où un attribut personnalisé peut être appliqué, s’il peut être répété et s’il est hérité. AttributeTargets.Property limite son utilisation aux propriétés.

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

Syntaxe

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]

System.AttributeUsageAttribute, écrit sous la forme [AttributeUsage(...)], se place sur une classe d’attribut personnalisé dérivée de Attribute. Il définit les règles d’application de cet attribut, et non le comportement des objets qu’il marque.

L’argument du constructeur de type AttributeTargets détermine la propriété en lecture seule ValidOn. Il s’agit d’une énumération de drapeaux : combinez les cibles avec |, par exemple AttributeTargets.Property | AttributeTargets.Field. AttributeTargets.Property seul autorise les propriétés, mais pas les champs ni les méthodes d’accesseur get et set. Une cible non autorisée entraîne une erreur de compilation.

AllowMultiple détermine si l’attribut peut apparaître plusieurs fois sur un même élément ; sa valeur par défaut est false. Inherited détermine si l’attribut est hérité par les classes dérivées et les membres redéfinis ; sa valeur par défaut est true. Cela ne signifie pas que la classe d’attribut elle-même est héritée. En l’absence de restriction explicite, les règles par défaut correspondent à AttributeTargets.All, AllowMultiple = false, Inherited = true.

Dans l’exemple, LabelAttribute ne peut apparaître qu’une seule fois sur une propriété et n’est pas hérité. [Label("Product name")] enregistre des métadonnées sur Name ; le code les lit par réflexion. L’attribut ne vérifie pas lui-même la valeur de la propriété. Les API utilisées sont disponibles dans .NET 10 ; l’exemple ne nécessite aucune fonctionnalité de langage en version preview.

Exemples

using System;

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
public sealed class LabelAttribute : Attribute
{
    public LabelAttribute(string text) => Text = text;
    public string Text { get; }
}

public sealed class Product
{
    [Label("Product name")]
    public string Name { get; set; } = "";
}

public static class Program
{
    public static void Main()
    {
        var property = typeof(Product).GetProperty(nameof(Product.Name))!;
        var label = (LabelAttribute)Attribute.GetCustomAttribute(
            property, typeof(LabelAttribute))!;
        Console.WriteLine(label.Text);
    }
}

Résultat

Product name

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