CKTIS / C#
AttributeUsageAttribute — reglas para atributos personalizados
AttributeUsageAttribute especifica dónde se puede aplicar un atributo personalizado, si se puede repetir y si se hereda. AttributeTargets.Property limita su uso a las propiedades.
Versión: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Sintaxis
[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]System.AttributeUsageAttribute, escrito como [AttributeUsage(...)], se coloca en una clase de atributo personalizado que deriva de Attribute. Define las reglas para aplicar ese atributo, no el comportamiento de los objetos marcados con él.
El argumento del constructor de tipo AttributeTargets determina la propiedad de solo lectura ValidOn. Es una enumeración de flags: combina los destinos con |, por ejemplo, AttributeTargets.Property | AttributeTargets.Field. AttributeTargets.Property por sí solo permite las propiedades, pero no los campos ni los métodos de acceso get y set. Un destino no permitido provoca un error de compilación.
AllowMultiple controla si el atributo puede aparecer varias veces en un elemento; su valor predeterminado es false. Inherited controla la herencia del atributo por parte de las clases derivadas y los miembros sobrescritos; su valor predeterminado es true. Esto no significa que se herede la propia clase del atributo. Sin una restricción explícita, las reglas predeterminadas corresponden a AttributeTargets.All, AllowMultiple = false, Inherited = true.
En el ejemplo, LabelAttribute solo puede aparecer una vez en una propiedad y no se hereda. [Label("Product name")] registra metadatos en Name; el código los lee mediante reflexión. El atributo no valida por sí mismo el valor de la propiedad. Las API utilizadas están disponibles en .NET 10; el ejemplo no requiere características del lenguaje en versión preview.
Ejemplos
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
El código mostrado y el resultado declarado se verificaron en un entorno aislado mediante el método registrado en la evidencia de verificación de esta versión exacta.