Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / C#

AttributeUsageAttribute — pravidla pro vlastní atributy

AttributeUsageAttribute určuje, kde lze vlastní atribut použít, zda se může opakovat a zda se dědí. AttributeTargets.Property omezuje jeho použití na vlastnosti.

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

Syntaxe

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

System.AttributeUsageAttribute, zapisovaný jako [AttributeUsage(...)], se umisťuje na třídu vlastního atributu odvozenou od Attribute. Určuje pravidla pro použití tohoto atributu, nikoli chování objektů, které jsou jím označeny.

Argument konstruktoru typu AttributeTargets určuje vlastnost pouze pro čtení ValidOn. Jde o výčtový typ s příznaky: cíle lze kombinovat operátorem |, například AttributeTargets.Property | AttributeTargets.Field. Samotné AttributeTargets.Property povoluje vlastnosti, nikoli pole nebo přístupové metody get a set. Nepovolený cíl způsobí chybu kompilace.

AllowMultiple určuje, zda se atribut může na jednom prvku vyskytovat opakovaně; výchozí hodnota je false. Inherited určuje dědění atributu odvozenými třídami a přepsanými členy; výchozí hodnota je true. Neznamená to, že se dědí samotná třída atributu. Výchozí pravidla bez výslovného omezení odpovídají hodnotám AttributeTargets.All, AllowMultiple = false, Inherited = true.

V příkladu se LabelAttribute může na vlastnosti vyskytovat pouze jednou a nedědí se. [Label("Product name")] ukládá metadata k Name; kód je načítá pomocí reflexe. Samotný atribut hodnotu vlastnosti neověřuje. Použitá API jsou dostupná v .NET 10; příklad nevyžaduje jazykové funkce ve verzi preview.

Příklady

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

Výsledek

Product name

Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.

Zdroje