Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / C#

AttributeUsageAttribute — regras para atributos personalizados

AttributeUsageAttribute especifica onde pode ser aplicado um atributo personalizado, se pode ser repetido e se é herdado. AttributeTargets.Property limita a sua utilização às propriedades.

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

Sintaxe

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

System.AttributeUsageAttribute, escrito como [AttributeUsage(...)], é colocado numa classe de atributo personalizado derivada de Attribute. Define regras para aplicar esse atributo, não o comportamento dos objetos assinalados com ele.

O argumento do construtor do tipo AttributeTargets determina a propriedade só de leitura ValidOn. Trata-se de uma enumeração de flags: combine os destinos com |, por exemplo, AttributeTargets.Property | AttributeTargets.Field. AttributeTargets.Property, por si só, permite propriedades, mas não campos nem os métodos de acesso get e set. Um destino não permitido provoca um erro de compilação.

AllowMultiple controla se o atributo pode aparecer várias vezes num elemento; o valor predefinido é false. Inherited controla a herança do atributo por classes derivadas e membros substituídos; o valor predefinido é true. Isto não significa que a própria classe do atributo seja herdada. Sem uma restrição explícita, as regras predefinidas correspondem a AttributeTargets.All, AllowMultiple = false, Inherited = true.

No exemplo, LabelAttribute só pode aparecer uma vez numa propriedade e não é herdado. [Label("Product name")] regista metadados em Name; o código lê-os através de reflexão. O próprio atributo não valida o valor da propriedade. As APIs utilizadas estão disponíveis no .NET 10; o exemplo não requer funcionalidades da linguagem em versão preview.

Exemplos

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

Resultado

Product name

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes