Bagikan melalui

MemberInfo.GetCustomAttributes Metode

  • Referensi

Definisi

Ruang nama:
System.Reflection
Rakitan:
System.Runtime.dll
Rakitan:
mscorlib.dll
Rakitan:
netstandard.dll

Saat ditimpa di kelas turunan, mengembalikan atribut kustom yang diterapkan ke anggota ini.

Overload

GetCustomAttributes(Boolean)

Saat ditimpa di kelas turunan, mengembalikan array semua atribut kustom yang diterapkan ke anggota ini.
GetCustomAttributes(Type, Boolean)

Saat ditimpa di kelas turunan, mengembalikan array atribut kustom yang diterapkan ke anggota ini dan diidentifikasi oleh Type.

GetCustomAttributes(Boolean)

Sumber:
MemberInfo.cs
Sumber:
MemberInfo.cs
Sumber:
MemberInfo.cs

Saat ditimpa di kelas turunan, mengembalikan array semua atribut kustom yang diterapkan ke anggota ini.

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

true untuk mencari rantai warisan anggota ini untuk menemukan atribut; jika tidak, false. Parameter ini diabaikan untuk properti dan peristiwa.

Mengembalikan

Object[]

Array yang berisi semua atribut kustom yang diterapkan ke anggota ini, atau array dengan elemen nol jika tidak ada atribut yang ditentukan.

Penerapan

GetCustomAttributes(Boolean) GetCustomAttributes(Boolean)

Pengecualian

InvalidOperationException

Anggota ini termasuk dalam jenis yang dimuat ke dalam konteks khusus refleksi. Lihat Cara: Memuat Rakitan ke dalam Konteks Khusus Refleksi.

TypeLoadException

Tipe atribut kustom tidak dapat dimuat.

Contoh

Contoh berikut mendefinisikan atribut kustom dan mengaitkan atribut dengan MyClass.MyMethod, mengambil atribut pada durasi, dan menampilkan hasilnya.

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

Keterangan

Metode ini mengabaikan inherit parameter untuk properti dan peristiwa. Untuk mencari rantai pewarisan untuk atribut pada properti dan peristiwa, gunakan kelebihan beban metode yang Attribute.GetCustomAttributes sesuai.

Catatan

Dalam .NET Framework versi 2.0, metode ini mengembalikan atribut keamanan pada metode, konstruktor, dan jenis jika disimpan dalam format metadata baru. Rakitan yang dikompilasi dengan versi 2.0 menggunakan format ini. Rakitan dan rakitan dinamis yang dikompilasi dengan versi .NET Framework sebelumnya menggunakan format XML lama. Lihat Memancarkan Atribut Keamanan Deklaratif.

Lihat juga

Berlaku untuk

GetCustomAttributes(Type, Boolean)

Sumber:
MemberInfo.cs
Sumber:
MemberInfo.cs
Sumber:
MemberInfo.cs

Saat ditimpa di kelas turunan, mengembalikan array atribut kustom yang diterapkan ke anggota ini dan diidentifikasi oleh 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()

Parameter

attributeType
Type

Jenis atribut yang akan dicari. Hanya atribut yang dapat ditetapkan untuk jenis ini yang dikembalikan.

inherit
Boolean

true untuk mencari rantai warisan anggota ini untuk menemukan atribut; jika tidak, false. Parameter ini diabaikan untuk properti dan peristiwa.

Mengembalikan

Object[]

Array atribut kustom yang diterapkan ke anggota ini, atau array dengan elemen nol jika tidak ada atribut yang dapat ditetapkan untuk attributeType diterapkan.

Penerapan

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

Pengecualian

TypeLoadException

Jenis atribut kustom tidak dapat dimuat.

ArgumentNullException

Jika attributeType adalah null.

InvalidOperationException

Anggota ini termasuk dalam jenis yang dimuat ke dalam konteks khusus refleksi. Lihat Cara: Memuat Rakitan ke dalam Konteks Khusus Refleksi.

Contoh

Contoh berikut mendefinisikan kelas bernama BaseClass yang memiliki dua anggota yang tidak diwariskan: bidang statis utas bernama total dan metode yang tidak mematuhi CLS bernama MethodA. Kelas bernama DerivedClass mewarisi dari BaseClass dan mengambil alih metodenya MethodA . Perhatikan bahwa tidak ada atribut yang diterapkan ke anggota DerivedClass. Contoh ini menguraikan anggota DerivedClass untuk menentukan apakah CLSCompliantAttribute atribut atau ThreadStaticAttribute seperti yang telah diterapkan kepada mereka. Karena inherit adalah true, metode mencari hierarki pewarisan DerivedClass untuk atribut yang ditentukan. Seperti yang ditunjukkan oleh output dari contoh, total bidang dihiasi dengan ThreadStaticAttribute atribut , dan MethodA metode dihiasi dengan CLSCompliantAttribute atribut .

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

Keterangan

Metode ini mengabaikan inherit parameter untuk properti dan peristiwa. Untuk mencari rantai pewarisan untuk atribut pada properti dan peristiwa, gunakan kelebihan beban metode yang Attribute.GetCustomAttributes sesuai.

Catatan

Dalam .NET Framework versi 2.0, metode ini mengembalikan atribut keamanan pada metode, konstruktor, dan jenis jika atribut disimpan dalam format metadata baru. Rakitan yang dikompilasi dengan versi 2.0 menggunakan format ini. Rakitan dan rakitan dinamis yang dikompilasi dengan versi .NET Framework sebelumnya menggunakan format XML lama. Lihat Memancarkan Atribut Keamanan Deklaratif.

Berlaku untuk