MemberInfo.GetCustomAttributes Metoda

Definice

Při přepsání v odvozené třídě vrátí vlastní atributy použité pro tohoto člena.When overridden in a derived class, returns custom attributes applied to this member.

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.When overridden in a derived class, returns an array of all custom attributes applied to this member.

GetCustomAttributes(Type, Boolean)

Při přepsání v odvozené třídě vrátí pole vlastních atributů použité pro tohoto člena a identifikováno pomocí Type.When overridden in a derived class, returns an array of custom attributes applied to this member and identified by 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.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()

Parametry

inherit
Boolean

trueChcete-li vyhledat atributy v řetězu dědičnosti tohoto člena, v opačném případě. falsetrue to search this member's inheritance chain to find the attributes; otherwise, false. Tento parametr je ignorován pro vlastnosti a události.This parameter is ignored for properties and events.

Návraty

Object[]

Pole, které obsahuje všechny vlastní atributy použité pro tohoto člena, nebo pole s nulovými prvky, pokud nejsou definovány žádné atributy.An array that contains all the custom attributes applied to this member, or an array with zero elements if no attributes are defined.

Implementuje

Výjimky

Tento člen patří do typu, který je načten do kontextu pouze pro reflexi.This member belongs to a type that is loaded into the reflection-only context. Viz jak: Načíst sestavení do kontextupouze pro reflexi.See How to: Load Assemblies into the Reflection-Only Context.

Nepovedlo se načíst vlastní typ atributu.A custom attribute type could not be loaded.

Příklady

Následující příklad definuje vlastní atribut a přidruží atribut k MyClass.MyMethod, načte atribut v době běhu a zobrazí výsledek.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

Poznámky

Tato metoda ignoruje inherit parametr pro vlastnosti a události.This method ignores the inherit parameter for properties and events. Chcete-li vyhledat řetězec dědičnosti pro atributy vlastností a událostí, použijte příslušná přetížení Attribute.GetCustomAttributes metody.To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

Poznámka

V .NET Framework verze 2,0 Tato metoda vrátí atributy zabezpečení u metod, konstruktorů a typů, pokud jsou uloženy v novém formátu metadat.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. V tomto formátu je sestavení zkompilováno s verzí 2,0.Assemblies compiled with version 2.0 use this format. Dynamická sestavení a sestavení kompilována s dřívějšími verzemi .NET Framework používají starý formát XML.Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. Viz generování deklarativních atributů zabezpečení.See Emitting Declarative Security Attributes.

Viz také

GetCustomAttributes(Type, Boolean)

Při přepsání v odvozené třídě vrátí pole vlastních atributů použité pro tohoto člena a identifikováno pomocí 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()

Parametry

attributeType
Type

Typ hledaného atributu.The type of attribute to search for. Vrátí se pouze atributy, které lze přiřadit tomuto typu.Only attributes that are assignable to this type are returned.

inherit
Boolean

trueChcete-li vyhledat atributy v řetězu dědičnosti tohoto člena, v opačném případě. falsetrue to search this member's inheritance chain to find the attributes; otherwise, false. Tento parametr je ignorován pro vlastnosti a události.This parameter is ignored for properties and events.

Návraty

Object[]

Pole vlastních atributů použité pro tohoto člena nebo pole s nulovými prvky, pokud nelze použít žádné atributy, které by attributeType bylo možné přiřadit.An array of custom attributes applied to this member, or an array with zero elements if no attributes assignable to attributeType have been applied.

Implementuje

Výjimky

Nelze načíst typ vlastního atributu.A custom attribute type cannot be loaded.

Pokud attributeType je null.If attributeType is null.

Tento člen patří do typu, který je načten do kontextu pouze pro reflexi.This member belongs to a type that is loaded into the reflection-only context. Viz jak: Načíst sestavení do kontextupouze pro reflexi.See How to: Load Assemblies into the Reflection-Only Context.

Příklady

Následující příklad definuje třídu s názvem BaseClass , která má dva nezděděné členy: statické pole vlákna s názvem total a metodu, která není kompatibilní se MethodAspecifikací CLS.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. Třída s názvem DerivedClass dědí z BaseClass a Přepisuje její MethodA metodu.A class named DerivedClass inherits from BaseClass and overrides its MethodA method. Všimněte si, že žádné atributy nejsou aplikovány na DerivedClassčleny.Note that no attributes are applied to the members of DerivedClass. Příklad provede iteraci členů DerivedClass , aby určil CLSCompliantAttribute , zda atribut nebo ThreadStaticAttribute byl pro ně použit.The example iterates the members of DerivedClass to determine whether the CLSCompliantAttribute or ThreadStaticAttribute attribute as been applied to them. Protože inherit je true, MetodaDerivedClass hledá hierarchii dědičnosti pro zadaný atribut.Because inherit is true, the method searches the inheritance hierarchy of DerivedClass for the specified attribute. Jak ukazuje total výstup z příkladu, pole je upraveno ThreadStaticAttribute atributem a MethodA metoda je upravena s CLSCompliantAttribute atributem.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

Poznámky

Tato metoda ignoruje inherit parametr pro vlastnosti a události.This method ignores the inherit parameter for properties and events. Chcete-li vyhledat řetězec dědičnosti pro atributy vlastností a událostí, použijte příslušná přetížení Attribute.GetCustomAttributes metody.To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

Poznámka

V .NET Framework verze 2,0 Tato metoda vrátí atributy zabezpečení v metodách, konstruktorech a typech, pokud jsou atributy uloženy v novém formátu metadat.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. V tomto formátu je sestavení zkompilováno s verzí 2,0.Assemblies compiled with version 2.0 use this format. Dynamická sestavení a sestavení kompilována s dřívějšími verzemi .NET Framework používají starý formát XML.Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. Viz generování deklarativních atributů zabezpečení.See Emitting Declarative Security Attributes.

Platí pro