MemberInfo.GetCustomAttributes Metoda

  • Reference

Definice

Obor názvů:
System.Reflection
Sestavení:
System.Runtime.dll
Sestavení:
netstandard.dll
Sestavení:
mscorlib.dll

Při přepsání v odvozené třídě vrátí vlastní atributy použité u tohoto členu.

Přetížení

GetCustomAttributes(Boolean)

Při přepsání v odvozené třídě vrátí pole všech vlastních atributů použitých pro tohoto člena.
GetCustomAttributes(Type, Boolean)

Při přepsání v odvozené třídě vrátí pole vlastních atributů použitých pro tohoto člena a identifikovaných objektem Type .

GetCustomAttributes(Boolean)

Při přepsání v odvozené třídě vrátí pole všech vlastních atributů použitých pro tohoto člena.

public:
 abstract cli::array <System::Object ^> ^ GetCustomAttributes(bool inherit);
public abstract object[] GetCustomAttributes (bool inherit);
abstract member GetCustomAttributes : bool -> obj[]
Public MustOverride Function GetCustomAttributes (inherit As Boolean) As Object()

Parametry

inherit
Boolean

true prohledat řetězec dědičnosti tohoto členu a najít atributy; v opačném případě false . Tento parametr se u vlastností a událostí ignoruje.

Návraty

Object[]

Pole, které obsahuje všechny vlastní atributy použité na tento člen, nebo pole s nulovými prvky, pokud nejsou definovány žádné atributy.

Implementuje

GetCustomAttributes(Boolean) GetCustomAttributes(Boolean)

Výjimky

InvalidOperationException

Tento člen patří do typu, který je načten do kontextu pouze reflexe. Viz Postupy: Načtení sestavení do Reflection-Only kontextu.

TypeLoadException

Vlastní typ atributu nelze načíst.

Příklady

Následující příklad definuje vlastní atribut a přidruží ho k atributu , načte atribut za běhu a MyClass.MyMethod zobrazí výsledek.

using namespace System;
using namespace System::Reflection;

// Define a custom attribute with one named parameter.

[AttributeUsage(AttributeTargets::All)]
public ref class MyAttribute: public Attribute
{
private:
   String^ myName;

public:
   MyAttribute( String^ name )
   {
      myName = name;
   }

   property String^ Name 
   {
      String^ get()
      {
         return myName;
      }
   }
};

// Define a class that has the custom attribute associated with one of its members.
public ref class MyClass1
{
public:

   [MyAttribute("This is an example attribute.")]
   void MyMethod( int i )
   {
      return;
   }
};

int main()
{
   try
   {
      // Get the type of MyClass1.
      Type^ myType = MyClass1::typeid;

      // Get the members associated with MyClass1.
      array<MemberInfo^>^myMembers = myType->GetMembers();

      // Display the attributes for each of the members of MyClass1.
      for ( int i = 0; i < myMembers->Length; i++ )
      {
         array<Object^>^myAttributes = myMembers[ i ]->GetCustomAttributes( true );
         if ( myAttributes->Length > 0 )
         {
            Console::WriteLine( "\nThe attributes for the member {0} are: \n", myMembers[ i ] );
            for ( int j = 0; j < myAttributes->Length; j++ )
               Console::WriteLine( "The type of the attribute is {0}.", myAttributes[ j ] );
         }
      }
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "An exception occurred: {0}", e->Message );
   }
}

using System;
using System.Reflection;

// Define a custom attribute with one named parameter.
[AttributeUsage(AttributeTargets.All)]
public class MyAttribute : Attribute
{
    private string myName;
    public MyAttribute(string name)
    {
        myName = name;
    }
    public string Name
    {
        get
        {
            return myName;
        }
    }
}

// Define a class that has the custom attribute associated with one of its members.
public class MyClass1
{
    [MyAttribute("This is an example attribute.")]
    public void MyMethod(int i)
    {
        return;
    }
}

public class MemberInfo_GetCustomAttributes
{
    public static void Main()
    {
        try
        {
            // Get the type of MyClass1.
            Type myType = typeof(MyClass1);
            // Get the members associated with MyClass1.
            MemberInfo[] myMembers = myType.GetMembers();

            // Display the attributes for each of the members of MyClass1.
            for(int i = 0; i < myMembers.Length; i++)
            {
                Object[] myAttributes = myMembers[i].GetCustomAttributes(true);
                if(myAttributes.Length > 0)
                {
                    Console.WriteLine("\nThe attributes for the member {0} are: \n", myMembers[i]);
                    for(int j = 0; j < myAttributes.Length; j++)
                        Console.WriteLine("The type of the attribute is {0}.", myAttributes[j]);
                }
            }
        }
        catch(Exception e)
        {
            Console.WriteLine("An exception occurred: {0}", e.Message);
        }
    }
}

Imports System.Reflection

' Define a custom attribute with one named parameter.
<AttributeUsage(AttributeTargets.All)> Public Class MyAttribute
    Inherits Attribute
    Private myName As String

    Public Sub New(ByVal name As String)
        myName = name
    End Sub

    Public ReadOnly Property Name() As String
        Get
            Return myName
        End Get
    End Property
End Class

' Define a class that has the custom attribute associated with one of its members.
Public Class MyClass1

    <MyAttribute("This is an example attribute.")> Public Sub MyMethod(ByVal i As Integer)
        Return
    End Sub
End Class


Public Class MemberInfo_GetCustomAttributes

    Public Shared Sub Main()
        Try
            ' Get the type of MyClass1.
            Dim myType As Type = GetType(MyClass1)
            ' Get the members associated with MyClass1.
            Dim myMembers As MemberInfo() = myType.GetMembers()

            ' Display the attributes for each of the members of MyClass1.
            Dim i As Integer
            For i = 0 To myMembers.Length - 1
                Dim myAttributes As [Object]() = myMembers(i).GetCustomAttributes(False)
                If myAttributes.Length > 0 Then
                    Console.WriteLine("The attributes for the member {0} are: ", myMembers(i))
                    Dim j As Integer
                    For j = 0 To myAttributes.Length - 1
                        Console.WriteLine("The type of the attribute is: {0}", myAttributes(j))
                    Next j
                End If
            Next i
        Catch e As Exception
            Console.WriteLine("An exception occurred: {0}.", e.Message)
        End Try
    End Sub
End Class

Poznámky

Tato metoda ignoruje inherit parametr pro vlastnosti a události. Pokud chcete v řetězu dědičnosti hledat atributy vlastností a událostí, použijte příslušná přetížení Attribute.GetCustomAttributes metody .

Poznámka

V .NET Framework verze 2.0 tato metoda vrátí atributy zabezpečení pro metody, konstruktory a typy, pokud jsou uloženy v novém formátu metadat. Sestavení zkompilovaná s verzí 2.0 používají tento formát. Dynamická sestavení a sestavení zkompilovaná se staršími verzemi .NET Framework používají starý formát XML. Viz Vysílání atributů deklarativního zabezpečení.

Viz také

Platí pro

GetCustomAttributes(Type, Boolean)

Při přepsání v odvozené třídě vrátí pole vlastních atributů použitých pro tohoto člena a identifikovaných objektem Type .

public:
 abstract cli::array <System::Object ^> ^ GetCustomAttributes(Type ^ attributeType, bool inherit);
public abstract object[] GetCustomAttributes (Type attributeType, bool inherit);
abstract member GetCustomAttributes : Type * bool -> obj[]
Public MustOverride Function GetCustomAttributes (attributeType As Type, inherit As Boolean) As Object()

Parametry

attributeType
Type

Typ atributu, který chcete vyhledat. Vrátí se pouze atributy, které jsou tomuto typu přiřaditelné.

inherit
Boolean

true prohledat řetězec dědičnosti tohoto členu a najít atributy; v opačném případě false . Tento parametr se u vlastností a událostí ignoruje.

Návraty

Object[]

Pole vlastních atributů použitých na tohoto člena nebo pole s nulovými prvky, pokud nebyly použity žádné atributy, které lze attributeType přiřadit.

Implementuje

GetCustomAttributes(Type, Boolean) GetCustomAttributes(Type, Boolean)

Výjimky

TypeLoadException

Vlastní typ atributu nelze načíst.

ArgumentNullException

Pokud attributeType je null .

InvalidOperationException

Tento člen patří do typu, který je načten do kontextu pouze reflexe. Viz Postupy: Načtení sestavení do Reflection-Only kontextu.

Příklady

Následující příklad definuje třídu s názvem , která má dva zděděné členy: statické pole vlákna s názvem a metodu nekompatibilní se specifikací CLS s BaseClass total názvem MethodA . Třída s názvem DerivedClass dědí z třídy BaseClass a přepisuje její MethodA metodu. Všimněte si, že nejsou použity žádné atributy na členy DerivedClass . Příklad iteruje členy , aby určil, zda je atribut DerivedClass CLSCompliantAttribute nebo použit na ThreadStaticAttribute ně. Vzhledem inherit k true tomu, že je , metoda vyhledá v hierarchii dědičnosti DerivedClass zadaného atributu . Jak ukazuje výstup z příkladu, pole je dekorované atributem a metoda total ThreadStaticAttribute je MethodA dekorována CLSCompliantAttribute atributem .

using System;

public class BaseClass
{
   [ThreadStatic] public int total;

   [CLSCompliant(false)] public virtual uint MethodA()
   {
      return (uint) 100;
   }
}

public class DerivedClass : BaseClass
{
   public override uint MethodA()
   {
      total++;
      return 200;
   }
}

public class Example
{
   public static void Main()
   {
      Type t = typeof(DerivedClass);
      Console.WriteLine("Members of {0}:", t.FullName);
      foreach (var m in t.GetMembers())
      {
         bool hasAttribute = false;
         Console.Write("   {0}: ", m.Name);
         if (m.GetCustomAttributes(typeof(CLSCompliantAttribute), true).Length > 0) {
            Console.Write("CLSCompliant");
            hasAttribute = true;
         }
         if (m.GetCustomAttributes(typeof(ThreadStaticAttribute), true).Length > 0) {
            Console.Write("ThreadStatic");
            hasAttribute = true;
         }
         if (! hasAttribute)
            Console.Write("No attributes");

         Console.WriteLine();
      }
   }
}
// The example displays the following output:
//       Members of DerivedClass:
//          MethodA: CLSCompliant
//          ToString: No attributes
//          Equals: No attributes
//          GetHashCode: No attributes
//          typeof: No attributes
//          .ctor: No attributes
//          total: ThreadStatic

Public Class BaseClass
   <ThreadStatic> Public total As Integer
   
   <CLSCompliant(False)> Public Overridable Function MethodA() As UInt32
      Return CUInt(100)
   End Function
End Class

Public Class DerivedClass : Inherits BaseClass
   Public Overrides Function MethodA() As UInt32
      total += 1
      Return 200
   End Function
End Class

Module Example
   Public Sub Main()
      Dim t As Type = GetType(DerivedClass)
      Console.WriteLine("Members of {0}:", t.FullName)
      For Each m In t.GetMembers()
         Dim hasAttribute As Boolean = False
         Console.Write("   {0}: ", m.Name)
         If m.GetCustomAttributes(GetType(CLSCompliantAttribute), True).Length > 0 Then
            Console.Write("CLSCompliant")
            hasAttribute = True
         End If
         If m.GetCustomAttributes(GetType(ThreadStaticAttribute), True).Length > 0 Then
            Console.Write("ThreadStatic")
            hasAttribute = True
         End If
         If Not hasAttribute Then
            Console.Write("No attributes")
         End If
         Console.WriteLine()
      Next
   End Sub
End Module
' The example displays the following output:
'       Members of DerivedClass:
'          MethodA: CLSCompliant
'          ToString: No attributes
'          Equals: No attributes
'          GetHashCode: No attributes
'          GetType: No attributes
'          .ctor: No attributes
'          total: ThreadStatic

Poznámky

Tato metoda ignoruje inherit parametr pro vlastnosti a události. Pokud chcete v řetězu dědičnosti hledat atributy vlastností a událostí, použijte příslušná přetížení Attribute.GetCustomAttributes metody .

Poznámka

V .NET Framework verze 2.0 tato metoda vrátí atributy zabezpečení pro metody, konstruktory a typy, pokud jsou atributy uloženy v novém formátu metadat. Sestavení zkompilovaná s verzí 2.0 používají tento formát. Dynamická sestavení a sestavení zkompilovaná se staršími verzemi .NET Framework používají starý formát XML. Viz Vysílání atributů deklarativního zabezpečení.

Platí pro