Sdílet prostřednictvím


AttributeUsage (C# a Visual Basic)

Určuje, jak lze použít vlastní atribut třídy.AttributeUsageje-li atribut, který lze použít pro definice vlastního atributu řídit, jak lze použít nový atribut.Nastavení výchozí vzhled při použití výslovně:

    <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 { }

V tomto příkladu NewAttribute třídy může být použit atribut možné kód subjektu, ale lze použít pouze jednou u každé entity.Přechází po u základní třídy odvozené třídy.

AllowMultiple a Inherited argumenty jsou volitelné, takže tento kód má stejný účinek:

<System.AttributeUsage(System.AttributeTargets.All)> 
Class NewAttribute
    Inherits System.Attribute
End Class
[System.AttributeUsage(System.AttributeTargets.All)]
class NewAttribute : System.Attribute { }

První AttributeUsage argument musí být jeden nebo více prvků AttributeTargets výčtu.Lze propojit více typů cíl spolu s operátorem OR následujícím způsobem:

Imports System


...


<AttributeUsage(AttributeTargets.Property Or AttributeTargets.Field)> 
Class NewPropertyOrFieldAttribute
    Inherits Attribute
End Class
using System;


...


[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
class NewPropertyOrFieldAttribute : Attribute { }

Pokud AllowMultiple argument je nastaven na true, a pak výsledné atribut lze použít více než jednou u jedna entita, například takto:

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 { }

V tomto případě MultiUseAttr lze použít opakovaně, protože AllowMultiple je nastavena na true.Oba formáty zobrazeny pro použití více atributů jsou platné.

Pokud Inherited je nastavena na false, a poté atribut nezdědí tříd, které jsou odvozeny od třídy, která je připisována.Příklad:

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 { }

V tomto případě Attr1 není DClass prostřednictvím dědičnosti.

Poznámky

AttributeUsage Jedno použití atributu je atribut nemůže být použito více než jednou do stejné třídy.AttributeUsageje alias AttributeUsageAttribute.

Další informace naleznete v tématu Přístup atributy pomocí odrazu (C# a Visual Basic).

Příklad

Následující příklad ukazuje účinek Inherited a AllowMultiple argumenty AttributeUsage atribut a jak můžete vlastní atributy pro třídu výčtu.

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

Vzorový výstup

Attributes on Base Class:
A1
A2
Attributes on Derived Class:
A3
A3
A2

Viz také

Referenční dokumentace

Odraz (C# a Visual Basic)

Atributy (C# a Visual Basic)

Vytvoření vlastní atributy (C# a Visual Basic)

Přístup atributy pomocí odrazu (C# a Visual Basic)

Attribute

System.Reflection

Koncepty

Příručka programování C#

Další zdroje

Příručka programování v jazyce Visual Basic

Rozšíření metadat pomocí atributů