MemberInfo.GetCustomAttributes Metoda

Definicja

Przestrzeń nazw:

System.Reflection

Zestaw:

System.Runtime.dll

Po przesłonięciu w klasie pochodnej zwraca atrybuty niestandardowe zastosowane do tego elementu członkowskiego.

Przeciążenia

GetCustomAttributes(Boolean)	Po zastąpieniu klasy pochodnej zwraca tablicę wszystkich atrybutów niestandardowych zastosowanych do tego elementu członkowskiego.
GetCustomAttributes(Type, Boolean)	Po przesłonięciu w klasie pochodnej zwraca tablicę atrybutów niestandardowych zastosowanych do tego elementu członkowskiego i zidentyfikowaną przez Typemetodę .

GetCustomAttributes(Boolean)

Źródło:

MemberInfo.cs

Po zastąpieniu klasy pochodnej zwraca tablicę wszystkich atrybutów niestandardowych zastosowanych do tego elementu członkowskiego.

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 aby wyszukać łańcuch dziedziczenia tego członka w celu znalezienia atrybutów; w przeciwnym razie , false. Ten parametr jest ignorowany dla właściwości i zdarzeń.

Zwraca

Object[]

Tablica zawierająca wszystkie atrybuty niestandardowe zastosowane do tego elementu członkowskiego lub tablicę z elementami zerowymi, jeśli nie zdefiniowano żadnych atrybutów.

Implementuje

GetCustomAttributes(Boolean)

Wyjątki

InvalidOperationException

Ten element członkowski należy do typu załadowanego do kontekstu tylko odbicia. Zobacz Instrukcje: ładowanie zestawów do kontekstu Reflection-Only.

TypeLoadException

Nie można załadować niestandardowego typu atrybutu.

Przykłady

Poniższy przykład definiuje atrybut niestandardowy i kojarzy atrybut z elementem MyClass.MyMethod, pobiera atrybut w czasie wykonywania i wyświetla wynik.

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

Uwagi

Ta metoda ignoruje inherit parametr właściwości i zdarzeń. Aby wyszukać łańcuch dziedziczenia dla atrybutów właściwości i zdarzeń, użyj odpowiednich przeciążeń Attribute.GetCustomAttributes metody .

Uwaga

W .NET Framework wersji 2.0 ta metoda zwraca atrybuty zabezpieczeń metod, konstruktorów i typów, jeśli są one przechowywane w nowym formacie metadanych. Zestawy skompilowane w wersji 2.0 używają tego formatu. Zestawy dynamiczne i zestawy skompilowane z wcześniejszymi wersjami .NET Framework używają starego formatu XML. Zobacz Emitowanie deklaratywnych atrybutów zabezpieczeń.

Zobacz też

• Object
• CustomAttributeBuilder

GetCustomAttributes(Type, Boolean)

Źródło:

MemberInfo.cs

Po przesłonięciu w klasie pochodnej zwraca tablicę atrybutów niestandardowych zastosowanych do tego elementu członkowskiego i zidentyfikowaną przez Typemetodę .

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 atrybutu do wyszukiwania. Zwracane są tylko atrybuty, które można przypisać do tego typu.

inherit

Boolean

true aby wyszukać łańcuch dziedziczenia tego członka w celu znalezienia atrybutów; w przeciwnym razie , false. Ten parametr jest ignorowany dla właściwości i zdarzeń.

Zwraca

Object[]

Tablica atrybutów niestandardowych zastosowanych do tego elementu członkowskiego lub tablicy z elementami zerowymi, jeśli nie zastosowano żadnych atrybutów do przypisania attributeType .

Implementuje

GetCustomAttributes(Type, Boolean)

Wyjątki

TypeLoadException

Nie można załadować typu niestandardowego atrybutu.

ArgumentNullException

Jeśli attributeType wartość to null.

InvalidOperationException

Ten element członkowski należy do typu załadowanego do kontekstu tylko odbicia. Zobacz Instrukcje: ładowanie zestawów do kontekstu Reflection-Only.

Przykłady

W poniższym przykładzie zdefiniowano klasę o nazwie BaseClass , która ma dwa nie dziedziczone elementy członkowskie: pole statyczne wątku o nazwie i metodę niezgodną ze standardem CLS o nazwie totalMethodA. Klasa o nazwie DerivedClass dziedziczy i BaseClass zastępuje jego MethodA metodę. Należy pamiętać, że żadne atrybuty nie są stosowane do elementów członkowskich .DerivedClass Przykład iteruje elementy członkowskie, DerivedClass aby określić, czy CLSCompliantAttribute atrybut lub ThreadStaticAttribute został zastosowany do nich. Ponieważ inherit jest to true, metoda wyszukuje hierarchię dziedziczenia DerivedClass dla określonego atrybutu. Jak pokazuje dane wyjściowe z przykładu, total pole jest ozdobione atrybutem ThreadStaticAttribute , a MethodA metoda jest ozdobiona atrybutem CLSCompliantAttribute .

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

Uwagi

Ta metoda ignoruje inherit parametr właściwości i zdarzeń. Aby wyszukać łańcuch dziedziczenia dla atrybutów właściwości i zdarzeń, użyj odpowiednich przeciążeń Attribute.GetCustomAttributes metody .

Uwaga

W .NET Framework wersji 2.0 ta metoda zwraca atrybuty zabezpieczeń metod, konstruktorów i typów, jeśli atrybuty są przechowywane w nowym formacie metadanych. Zestawy skompilowane w wersji 2.0 używają tego formatu. Zestawy dynamiczne i zestawy skompilowane z wcześniejszymi wersjami .NET Framework używają starego formatu XML. Zobacz Emitowanie deklaratywnych atrybutów zabezpieczeń.