AttributeUsage (C# e Visual Basic)
Determina como uma classe de atributo personalizado pode ser usada. AttributeUsageé um atributo que pode ser aplicado às definições de atributo personalizado para controlar como o novo atributo pode ser aplicado. As configurações padrão de aparência quando aplicado explicitamente:
<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 { }
Neste exemplo, o NewAttribute classe pode ser aplicado a qualquer entidade capaz de atributo de código, mas pode ser aplicado apenas uma vez para cada entidade. Ela é herdada por classes derivadas, quando aplicado a uma classe base.
O AllowMultiple e Inherited argumentos são opcionais, portanto, esse código tem o mesmo efeito:
<System.AttributeUsage(System.AttributeTargets.All)>
Class NewAttribute
Inherits System.Attribute
End Class
[System.AttributeUsage(System.AttributeTargets.All)]
class NewAttribute : System.Attribute { }
O primeiro AttributeUsage o argumento deve ser um ou mais elementos da AttributeTargets enumeração. Podem ser vinculados a vários tipos de destino com o operador ou, como este:
Imports System
...
<AttributeUsage(AttributeTargets.Property Or AttributeTargets.Field)>
Class NewPropertyOrFieldAttribute
Inherits Attribute
End Class
using System;
...
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
class NewPropertyOrFieldAttribute : Attribute { }
Se o AllowMultiple argumento estiver definido como true, e em seguida, o atributo resultante pode ser aplicado mais de uma vez, a uma única entidade, como este:
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 { }
Nesse caso MultiUseAttr pode ser aplicado várias vezes porque AllowMultiple for definido como true. Ambos os formatos mostrados para a aplicação de vários atributos são válidos.
Se Inherited for definido como false, e em seguida, o atributo não é herdado pelas classes derivadas de uma classe que está atribuída. Por exemplo:
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 { }
Nesse caso Attr1 não é aplicada a DClass por meio de herança.
Comentários
O AttributeUsage é um atributo de uso único – não pode ser aplicado mais de uma vez para a mesma classe. AttributeUsageé um alias para AttributeUsageAttribute.
Para obter mais informações, consulte Acessar atributos usando reflexão (C# e Visual Basic).
Exemplo
O exemplo a seguir demonstra o efeito do Inherited e AllowMultiple argumentos para o AttributeUsage atributo e como os atributos personalizados aplicados a uma classe podem ser enumerados.
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);
}
}
}
Saída de exemplo
Attributes on Base Class:
A1
A2
Attributes on Derived Class:
A3
A3
A2
Consulte também
Referência
Criando os atributos personalizados (C# e Visual Basic)
Acessar atributos usando reflexão (C# e Visual Basic)
Conceitos
Estendendo metadados usando atributos