WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / C#

AttributeUsageAttribute — Regeln für benutzerdefinierte Attribute

AttributeUsageAttribute legt fest, wo ein benutzerdefiniertes Attribut verwendet werden darf, ob es wiederholt werden kann und ob es vererbt wird. AttributeTargets.Property beschränkt seine Verwendung auf Eigenschaften.

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

Syntax

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

System.AttributeUsageAttribute, geschrieben als [AttributeUsage(...)], wird auf einer benutzerdefinierten Attributklasse platziert, die von Attribute abgeleitet ist. Es legt Regeln für die Verwendung dieses Attributs fest, nicht das Verhalten der damit markierten Objekte.

Das Konstruktorargument vom Typ AttributeTargets bestimmt die schreibgeschützte Eigenschaft ValidOn. Dabei handelt es sich um eine Flags-Aufzählung: Ziele lassen sich mit | kombinieren, zum Beispiel AttributeTargets.Property | AttributeTargets.Field. AttributeTargets.Property allein erlaubt Eigenschaften, aber keine Felder oder die Zugriffsmethoden get und set. Ein unzulässiges Ziel führt zu einem Kompilierungsfehler.

AllowMultiple steuert, ob das Attribut mehrfach auf einem Element erscheinen darf; der Standardwert ist false. Inherited steuert die Vererbung des Attributs durch abgeleitete Klassen und überschreibende Member; der Standardwert ist true. Das bedeutet nicht, dass die Attributklasse selbst vererbt wird. Die Standardregeln ohne ausdrückliche Einschränkung entsprechen AttributeTargets.All, AllowMultiple = false, Inherited = true.

Im Beispiel darf LabelAttribute nur einmal auf einer Eigenschaft erscheinen und wird nicht vererbt. [Label("Product name")] speichert Metadaten für Name; der Code liest sie mithilfe von Reflection aus. Das Attribut selbst überprüft den Wert der Eigenschaft nicht. Die verwendeten APIs sind in .NET 10 verfügbar; das Beispiel benötigt keine Preview-Sprachfunktionen.

Beispiele

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);
    }
}

Ergebnis

Product name

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen