AttributeUsage (C# et Visual Basic)
Détermine comment une classe d'attributs personnalisés peut être utilisée. AttributeUsage est un attribut qui peut être appliqué à des définitions d'attributs personnalisées pour contrôler la façon dont le nouvel attribut peut être appliqué. Les paramètres par défaut se présentent comme suit lorsqu'ils sont appliqués explicitement :
<System.AttributeUsage(System.AttributeTargets.All,
AllowMultiple:=False,
Inherited:=True)>
Class NewAttribute
Inherits System.Attribute
End Class
[System.AttributeUsage(System.AttributeTargets.All,
AllowMultiple = false,
Inherited = true)]
class NewAttribute : System.Attribute { }
Dans cet exemple, la classe NewAttribute peut être appliquée à toute entité de code pouvant prendre des attributs, mais ne peut s'appliquer qu'une fois à chaque entité. Les classes dérivées en héritent dans le cas d'une classe de base.
Les arguments AllowMultiple et Inherited sont facultatifs, donc ce code a le même effet :
<System.AttributeUsage(System.AttributeTargets.All)>
Class NewAttribute
Inherits System.Attribute
End Class
[System.AttributeUsage(System.AttributeTargets.All)]
class NewAttribute : System.Attribute { }
Le premier argument AttributeUsage doit être un ou plusieurs éléments de l'énumération AttributeTargets. Plusieurs types de cibles peuvent être liés avec l'opérateur OR de la façon suivante :
Imports System
...
<AttributeUsage(AttributeTargets.Property Or AttributeTargets.Field)>
Class NewPropertyOrFieldAttribute
Inherits Attribute
End Class
using System;
...
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
class NewPropertyOrFieldAttribute : Attribute { }
Si l'argument AllowMultiple a la valeur true, l'attribut qui en résulte peut être appliqué plusieurs fois à une même entité, de la manière suivante :
Imports System
...
<AttributeUsage(AttributeTargets.Class, AllowMultiple:=True)>
Class MultiUseAttr
Inherits Attribute
End Class
<MultiUseAttr(), MultiUseAttr()>
Class Class1
End Class
using System;
...
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
class MultiUseAttr : Attribute { }
[MultiUseAttr]
[MultiUseAttr]
class Class1 { }
[MultiUseAttr, MultiUseAttr]
class Class2 { }
Dans ce cas, MultiUseAttr peut être appliqué à plusieurs reprises parce que AllowMultiple a la valeur true. Les deux formats indiqués pour appliquer plusieurs attributs sont valides.
Si Inherited a la valeur false, les classes dérivées d'une classe attribuée n'héritent pas de l'attribut. Par exemple :
Imports System
...
<AttributeUsage(AttributeTargets.Class, Inherited:=False)>
Class Attr1
Inherits Attribute
End Class
<Attr1()>
Class BClass
End Class
Class DClass
Inherits BClass
End Class
using System;
...
[AttributeUsage(AttributeTargets.Class, Inherited = false)]
class Attr1 : Attribute { }
[Attr1]
class BClass { }
class DClass : BClass { }
Dans ce cas, Attr1 n'est pas appliqué à DClass par héritage.
Notes
L'attribut AttributeUsage est un attribut à usage unique ; il ne peut pas s'appliquer plusieurs fois à la même classe. AttributeUsage est un alias de AttributeUsageAttribute.
Pour plus d’informations, consultez Accès à des attributs à l'aide de la réflexion (C# et Visual Basic).
Exemple
L'exemple suivant montre l'effet des arguments Inherited et AllowMultiple sur l'attribut AttributeUsage, et la façon dont les attributs personnalisés appliqués à une classe peuvent être énumérés.
Imports System
...
' Create some custom attributes:
<AttributeUsage(System.AttributeTargets.Class, Inherited:=False)>
Class A1
Inherits System.Attribute
End Class
<AttributeUsage(System.AttributeTargets.Class)>
Class A2
Inherits System.Attribute
End Class
<AttributeUsage(System.AttributeTargets.Class, AllowMultiple:=True)>
Class A3
Inherits System.Attribute
End Class
' Apply custom attributes to classes:
<A1(), A2()>
Class BaseClass
End Class
<A3(), A3()>
Class DerivedClass
Inherits BaseClass
End Class
Public Class TestAttributeUsage
Sub Main()
Dim b As New BaseClass
Dim d As New DerivedClass
' Display custom attributes for each class.
Console.WriteLine("Attributes on Base Class:")
Dim attrs() As Object = b.GetType().GetCustomAttributes(True)
For Each attr In attrs
Console.WriteLine(attr)
Next
Console.WriteLine("Attributes on Derived Class:")
attrs = d.GetType().GetCustomAttributes(True)
For Each attr In attrs
Console.WriteLine(attr)
Next
End Sub
End Class
using System;
...
// Create some custom attributes:
[AttributeUsage(System.AttributeTargets.Class, Inherited = false)]
class A1 : System.Attribute { }
[AttributeUsage(System.AttributeTargets.Class)]
class A2 : System.Attribute { }
[AttributeUsage(System.AttributeTargets.Class, AllowMultiple = true)]
class A3 : System.Attribute { }
// Apply custom attributes to classes:
[A1, A2]
class BaseClass { }
[A3, A3]
class DerivedClass : BaseClass { }
public class TestAttributeUsage
{
static void Main()
{
BaseClass b = new BaseClass();
DerivedClass d = new DerivedClass();
// Display custom attributes for each class.
Console.WriteLine("Attributes on Base Class:");
object[] attrs = b.GetType().GetCustomAttributes(true);
foreach (Attribute attr in attrs)
{
Console.WriteLine(attr);
}
Console.WriteLine("Attributes on Derived Class:");
attrs = d.GetType().GetCustomAttributes(true);
foreach (Attribute attr in attrs)
{
Console.WriteLine(attr);
}
}
}
Résultat de l'exemple
Attributes on Base Class:
A1
A2
Attributes on Derived Class:
A3
A3
A2
Voir aussi
Référence
Réflexion (C# et Visual Basic)
Attributs (C# et Visual Basic)
Création d'attributs personnalisés (C# et Visual Basic)
Accès à des attributs à l'aide de la réflexion (C# et Visual Basic)