MemberInfo.GetCustomAttributes Yöntem

Tanım

Türetilmiş bir sınıfta geçersiz kılınırsa, bu üyeye uygulanan özel öznitelikleri döndürür.When overridden in a derived class, returns custom attributes applied to this member.

Aşırı Yüklemeler

GetCustomAttributes(Boolean)

Türetilmiş bir sınıfta geçersiz kılınırsa, bu üyeye uygulanan tüm özel özniteliklerin dizisini döndürür.When overridden in a derived class, returns an array of all custom attributes applied to this member.

GetCustomAttributes(Type, Boolean)

Türetilmiş bir sınıfta geçersiz kılınırsa, bu üyeye uygulanan ve tarafından tanımlanan özel özniteliklerin bir dizisini döndürür Type .When overridden in a derived class, returns an array of custom attributes applied to this member and identified by Type.

GetCustomAttributes(Boolean)

Türetilmiş bir sınıfta geçersiz kılınırsa, bu üyeye uygulanan tüm özel özniteliklerin dizisini döndürür.When overridden in a derived class, returns an array of all custom attributes applied to this member.

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

Parametreler

inherit
Boolean

true öznitelikleri bulmak için bu üyenin devralma zincirini aramak için; Aksi takdirde, false .true to search this member's inheritance chain to find the attributes; otherwise, false. Bu parametre, Özellikler ve olaylar için yok sayılır.This parameter is ignored for properties and events.

Döndürülenler

Object[]

Bu üyeye uygulanan tüm özel öznitelikleri içeren bir dizi veya hiçbir öznitelik tanımlanmazsa sıfır öğe içeren bir dizi.An array that contains all the custom attributes applied to this member, or an array with zero elements if no attributes are defined.

Uygulamalar

Özel durumlar

Bu üye yalnızca yansıma bağlamına yüklenmiş bir türe ait.This member belongs to a type that is loaded into the reflection-only context. Bkz. nasıl yapılır: derlemeleri Reflection-Only bağlamına yükleme.See How to: Load Assemblies into the Reflection-Only Context.

Özel bir öznitelik türü yüklenemedi.A custom attribute type could not be loaded.

Örnekler

Aşağıdaki örnek, özel bir özniteliği tanımlar ve özniteliğini ile ilişkilendirir MyClass.MyMethod , çalışma zamanında özniteliğini alır ve sonucu görüntüler.The following example defines a custom attribute and associates the attribute with MyClass.MyMethod, retrieves the attribute at run time, and displays the result.

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

Açıklamalar

Bu yöntem, inherit Özellikler ve olaylar için parametresini yoksayar.This method ignores the inherit parameter for properties and events. Özellikler ve olaylardaki öznitelikler için devralma zincirinde arama yapmak için, yönteminin uygun aşırı yüklerini kullanın Attribute.GetCustomAttributes .To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

Not

.NET Framework sürüm 2,0 ' de, bu yöntem, yeni meta veri biçiminde depolandıklarında Yöntemler, oluşturucular ve türlerde güvenlik özniteliklerini döndürür.In the .NET Framework version 2.0, this method returns security attributes on methods, constructors, and types if they are stored in the new metadata format. Sürüm 2,0 ile derlenen derlemeler bu biçimi kullanır.Assemblies compiled with version 2.0 use this format. .NET Framework önceki sürümleriyle derlenen dinamik derlemeler ve derlemeler eski XML biçimini kullanır.Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. Bkz. bildirim temelli güvenlik özniteliklerini yayma.See Emitting Declarative Security Attributes.

Ayrıca bkz.

Şunlara uygulanır

GetCustomAttributes(Type, Boolean)

Türetilmiş bir sınıfta geçersiz kılınırsa, bu üyeye uygulanan ve tarafından tanımlanan özel özniteliklerin bir dizisini döndürür Type .When overridden in a derived class, returns an array of custom attributes applied to this member and identified by 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()

Parametreler

attributeType
Type

Aranacak özniteliğin türü.The type of attribute to search for. Yalnızca bu türe atanabilen öznitelikler döndürülür.Only attributes that are assignable to this type are returned.

inherit
Boolean

true öznitelikleri bulmak için bu üyenin devralma zincirini aramak için; Aksi takdirde, false .true to search this member's inheritance chain to find the attributes; otherwise, false. Bu parametre, Özellikler ve olaylar için yok sayılır.This parameter is ignored for properties and events.

Döndürülenler

Object[]

Bu üyeye uygulanan özel özniteliklerin dizisi veya hiçbir öznitelik uygulanamayan bir dizin yoksa sıfır öğe içeren bir dizi attributeType .An array of custom attributes applied to this member, or an array with zero elements if no attributes assignable to attributeType have been applied.

Uygulamalar

Özel durumlar

Özel öznitelik türü yüklenemiyor.A custom attribute type cannot be loaded.

İse attributeType null .If attributeType is null.

Bu üye yalnızca yansıma bağlamına yüklenmiş bir türe ait.This member belongs to a type that is loaded into the reflection-only context. Bkz. nasıl yapılır: derlemeleri Reflection-Only bağlamına yükleme.See How to: Load Assemblies into the Reflection-Only Context.

Örnekler

Aşağıdaki örnek, BaseClass devralınan iki üyeye sahip olan adlı bir sınıfı tanımlar: adlı bir iş parçacığı statik alanı total ve adlı CLS uyumlu olmayan bir yöntem MethodA .The following example defines a class named BaseClass that has two non-inherited members: a thread static field named total and a non-CLS-compliant method named MethodA. Adlı bir sınıf DerivedClass öğesinden devralır BaseClass ve metodunu geçersiz kılar MethodA .A class named DerivedClass inherits from BaseClass and overrides its MethodA method. Üyelerine hiçbir öznitelik uygulanmadığını unutmayın DerivedClass .Note that no attributes are applied to the members of DerivedClass. Örnek, DerivedClass CLSCompliantAttribute veya ThreadStaticAttribute özniteliğinin uygulanıp uygulanmadığını belirleyecek şekilde üyelerini yineler.The example iterates the members of DerivedClass to determine whether the CLSCompliantAttribute or ThreadStaticAttribute attribute as been applied to them. Olduğundan inherit true , yöntemi belirtilen öznitelik için devralma hiyerarşisinde arama yapar DerivedClass .Because inherit is true, the method searches the inheritance hierarchy of DerivedClass for the specified attribute. Örneğin çıkışının gösterdiği gibi, total alanı özniteliğiyle birlikte tasarlanmıştır ThreadStaticAttribute ve MethodA yöntemi özniteliğiyle birlikte tasarlanmıştır CLSCompliantAttribute .As the output from the example shows, the total field is decorated with the ThreadStaticAttribute attribute, and the MethodA method is decorated with the CLSCompliantAttribute attribute.

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

Açıklamalar

Bu yöntem, inherit Özellikler ve olaylar için parametresini yoksayar.This method ignores the inherit parameter for properties and events. Özellikler ve olaylardaki öznitelikler için devralma zincirinde arama yapmak için, yönteminin uygun aşırı yüklerini kullanın Attribute.GetCustomAttributes .To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

Not

.NET Framework sürüm 2,0 ' de, bu yöntem Yöntemler, oluşturucular ve türlerde güvenlik özniteliklerini, öznitelikler yeni meta veri biçiminde depolanıyorsa döndürür.In the .NET Framework version 2.0, this method returns security attributes on methods, constructors, and types if the attributes are stored in the new metadata format. Sürüm 2,0 ile derlenen derlemeler bu biçimi kullanır.Assemblies compiled with version 2.0 use this format. .NET Framework önceki sürümleriyle derlenen dinamik derlemeler ve derlemeler eski XML biçimini kullanır.Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. Bkz. bildirim temelli güvenlik özniteliklerini yayma.See Emitting Declarative Security Attributes.

Şunlara uygulanır