Condividi tramite

Creare attributi personalizzati

È possibile creare attributi personalizzati definendo una classe di attributi, una classe che deriva direttamente o indirettamente da Attribute, che semplifica l'identificazione delle definizioni degli attributi nei metadati. Si supponga di voler contrassegnare i tipi con il nome del programmatore che ha scritto il tipo. È possibile definire una classe di attributi personalizzata Author :

[System.AttributeUsage(System.AttributeTargets.Class |
                       System.AttributeTargets.Struct)
]
public class AuthorAttribute : System.Attribute
{
    private string Name;
    public double Version;

    public AuthorAttribute(string name)
    {
        Name = name;
        Version = 1.0;
    }
}

Il nome della classe è il nome dell'attributo AuthorAttribute, Author, con il suffisso Attribute. È derivato da System.Attribute, quindi è una classe di attributi personalizzata. I parametri del costruttore sono i parametri posizionali dell'attributo personalizzato. In questo esempio è name un parametro posizionale. Tutti i campi o le proprietà pubbliche di lettura/scrittura sono parametri denominati. In questo caso, version è l'unico parametro denominato. Si noti l'uso dell'attributo AttributeUsage per rendere l'attributo Author valido solo su classi e dichiarazioni struct.

È possibile usare questo nuovo attributo come indicato di seguito:

[Author("P. Ackerman", Version = 1.1)]
class SampleClass
{
    // P. Ackerman's code goes here...
}

AttributeUsage ha un parametro denominato, AllowMultiple, con cui è possibile creare un attributo personalizzato a uso singolo o multiuso. Nell'esempio di codice seguente viene creato un attributo multiuso.

[System.AttributeUsage(System.AttributeTargets.Class |
                       System.AttributeTargets.Struct,
                       AllowMultiple = true)  // Multiuse attribute.
]
public class AuthorAttribute : System.Attribute
{
    string Name;
    public double Version;

    public AuthorAttribute(string name)
    {
        Name = name;

        // Default value.
        Version = 1.0;
    }

    public string GetName() => Name;
}

Nell'esempio di codice seguente vengono applicati più attributi dello stesso tipo a una classe.

[Author("P. Ackerman"), Author("R. Koch", Version = 2.0)]
public class ThirdClass
{
    // ...
}

Vedere anche