Freigeben über


MemberInfo.GetCustomAttributes Methode

Definition

Wenn sie in einer abgeleiteten Klasse überschrieben wird, werden benutzerdefinierte Attribute zurückgegeben, die auf dieses Element angewendet werden.

Überlädt

Name Beschreibung
GetCustomAttributes(Boolean)

Wenn eine abgeleitete Klasse außer Kraft gesetzt wird, wird ein Array aller benutzerdefinierten Attribute zurückgegeben, die auf dieses Element angewendet werden.

GetCustomAttributes(Type, Boolean)

Wenn eine abgeleitete Klasse überschrieben wird, wird ein Array von benutzerdefinierten Attributen zurückgegeben, die auf dieses Element angewendet und durch Typediese identifiziert werden.

GetCustomAttributes(Boolean)

Quelle:
MemberInfo.cs
Quelle:
MemberInfo.cs
Quelle:
MemberInfo.cs
Quelle:
MemberInfo.cs
Quelle:
MemberInfo.cs

Wenn eine abgeleitete Klasse außer Kraft gesetzt wird, wird ein Array aller benutzerdefinierten Attribute zurückgegeben, die auf dieses Element angewendet werden.

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()

Parameter

inherit
Boolean

trueum die Vererbungskette dieses Mitglieds zu durchsuchen, um die Attribute zu finden; andernfalls . false Dieser Parameter wird für Eigenschaften und Ereignisse ignoriert.

Gibt zurück

Object[]

Ein Array, das alle auf dieses Element angewendeten benutzerdefinierten Attribute enthält, oder ein Array mit Nullelementen, wenn keine Attribute definiert sind.

Implementiert

Ausnahmen

Dieses Element gehört zu einem Typ, der in den reinen Spiegelungskontext geladen wird. Weitere Informationen finden Sie unter How to: Load Assemblies into the Reflection-Only Context.

Ein benutzerdefinierter Attributtyp konnte nicht geladen werden.

Beispiele

Im folgenden Beispiel wird ein benutzerdefiniertes Attribut definiert und das Attribut MyClass.MyMethodzugeordnet, das Attribut zur Laufzeit abgerufen und das Ergebnis angezeigt.

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

Hinweise

Diese Methode ignoriert den inherit Parameter für Eigenschaften und Ereignisse. Um die Vererbungskette nach Attributen für Eigenschaften und Ereignisse zu durchsuchen, verwenden Sie die entsprechenden Überladungen der Attribute.GetCustomAttributes Methode.

Weitere Informationen

Gilt für:

GetCustomAttributes(Type, Boolean)

Quelle:
MemberInfo.cs
Quelle:
MemberInfo.cs
Quelle:
MemberInfo.cs
Quelle:
MemberInfo.cs
Quelle:
MemberInfo.cs

Wenn eine abgeleitete Klasse überschrieben wird, wird ein Array von benutzerdefinierten Attributen zurückgegeben, die auf dieses Element angewendet und durch Typediese identifiziert werden.

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()

Parameter

attributeType
Type

Der Typ des attributs, nach dem gesucht werden soll. Es werden nur Attribute zurückgegeben, die diesem Typ zugewiesen werden können.

inherit
Boolean

trueum die Vererbungskette dieses Mitglieds zu durchsuchen, um die Attribute zu finden; andernfalls . false Dieser Parameter wird für Eigenschaften und Ereignisse ignoriert.

Gibt zurück

Object[]

Ein Array von benutzerdefinierten Attributen, die auf dieses Element angewendet werden, oder ein Array mit Nullelementen, wenn keine Attribute zugewiesen wurden, die attributeType zugewiesen wurden.

Implementiert

Ausnahmen

Ein benutzerdefinierter Attributtyp kann nicht geladen werden.

Wenn attributeType ist null.

Dieses Element gehört zu einem Typ, der in den reinen Spiegelungskontext geladen wird. Weitere Informationen finden Sie unter How to: Load Assemblies into the Reflection-Only Context.

Beispiele

Im folgenden Beispiel wird eine Klasse definiert, die über zwei nicht geerbte Member verfügt BaseClass : ein statisches Threadfeld mit dem Namen total und eine nicht CLS-kompatible Methode mit dem Namen MethodA. Eine benannte DerivedClass Klasse erbt von BaseClass der Methode und überschreibt die MethodA Methode. Beachten Sie, dass keine Attribute auf die Member von DerivedClass. Im Beispiel werden die Member DerivedClass durchläuft, um zu bestimmen, ob das CLSCompliantAttribute oder ThreadStaticAttribute das Attribut auf sie angewendet wurde. Die Methode durchsucht die inherittrueVererbungshierarchie des DerivedClass angegebenen Attributs. Wie die Ausgabe aus dem Beispiel zeigt, wird das total Feld mit dem ThreadStaticAttribute Attribut versehen, und die MethodA Methode wird mit dem CLSCompliantAttribute Attribut versehen.

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

Hinweise

Diese Methode ignoriert den inherit Parameter für Eigenschaften und Ereignisse. Um die Vererbungskette nach Attributen für Eigenschaften und Ereignisse zu durchsuchen, verwenden Sie die entsprechenden Überladungen der Attribute.GetCustomAttributes Methode.

Gilt für: