MemberInfo.GetCustomAttributes MemberInfo.GetCustomAttributes MemberInfo.GetCustomAttributes MemberInfo.GetCustomAttributes Method

Definição

Quando substituído em uma classe derivada, retorna atributos personalizados aplicados a esse membro.When overridden in a derived class, returns custom attributes applied to this member.

Sobrecargas

GetCustomAttributes(Boolean) GetCustomAttributes(Boolean) GetCustomAttributes(Boolean) GetCustomAttributes(Boolean)

Quando substituído em uma classe derivada, retorna uma matriz de todos os atributos personalizados aplicados a esse membro.When overridden in a derived class, returns an array of all custom attributes applied to this member.

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

Quando substituído em uma classe derivada, retorna uma matriz de atributos personalizados aplicados a esse membro e identificados por Type.When overridden in a derived class, returns an array of custom attributes applied to this member and identified by Type.

GetCustomAttributes(Boolean) GetCustomAttributes(Boolean) GetCustomAttributes(Boolean) GetCustomAttributes(Boolean)

Quando substituído em uma classe derivada, retorna uma matriz de todos os atributos personalizados aplicados a esse membro.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()

Parâmetros

inherit
Boolean Boolean Boolean Boolean

true para pesquisar a cadeia de herança desse membro para encontrar os atributos; caso contrário, false.true to search this member's inheritance chain to find the attributes; otherwise, false. Esse parâmetro é ignorado para propriedades e eventos.This parameter is ignored for properties and events.

Retornos

Object[]

Uma matriz que contém todos os atributos personalizados aplicados a esse membro ou uma matriz com zero elementos se nenhum atributo for definido.An array that contains all the custom attributes applied to this member, or an array with zero elements if no attributes are defined.

Implementações

Exceções

Esse membro pertence a um tipo carregado no contexto somente reflexão.This member belongs to a type that is loaded into the reflection-only context. Confira Como carregar assemblies no contexto somente de reflexão.See How to: Load Assemblies into the Reflection-Only Context.

Um tipo de atributo personalizado não pôde ser carregado.A custom attribute type could not be loaded.

Exemplos

O exemplo a seguir define um atributo personalizado e associa o atributo MyClass.MyMethoda, recupera o atributo em tempo de execução e exibe o resultado.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 'New

    Public ReadOnly Property Name() As String
        Get
            Return myName
        End Get
    End Property
End Class 'MyAttribute

' 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 'MyMethod
End Class 'MyClass1


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 'Main
End Class 'MemberInfo_GetCustomAttributes

Comentários

Esse método ignora o inherit parâmetro para propriedades e eventos.This method ignores the inherit parameter for properties and events. Para pesquisar os atributos da cadeia de herança em Propriedades e eventos, use as sobrecargas apropriadas do Attribute.GetCustomAttributes método.To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

Observação

No .NET Framework versão 2,0, esse método retorna atributos de segurança em métodos, construtores e tipos se eles forem armazenados no novo formato de metadados.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. Os assemblies compilados com a versão 2,0 usam esse formato.Assemblies compiled with version 2.0 use this format. Assemblies dinâmicos e assemblies compilados com versões anteriores do .NET Framework usam o formato XML antigo.Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. Consulte emitindo atributos de segurança declarativos.See Emitting Declarative Security Attributes.

Veja também

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

Quando substituído em uma classe derivada, retorna uma matriz de atributos personalizados aplicados a esse membro e identificados por 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()

Parâmetros

attributeType
Type Type Type Type

O tipo de atributo a ser pesquisado.The type of attribute to search for. Somente os atributos que podem ser atribuídos a esse tipo são retornados.Only attributes that are assignable to this type are returned.

inherit
Boolean Boolean Boolean Boolean

true para pesquisar a cadeia de herança desse membro para encontrar os atributos; caso contrário, false.true to search this member's inheritance chain to find the attributes; otherwise, false. Esse parâmetro é ignorado para propriedades e eventos.This parameter is ignored for properties and events.

Retornos

Object[]

Uma matriz de atributos personalizados aplicados a este membro ou uma matriz com zero elemento se nenhum atributo que puder ser atribuído a attributeType for aplicado.An array of custom attributes applied to this member, or an array with zero elements if no attributes assignable to attributeType have been applied.

Implementações

Exceções

Um tipo de atributo personalizado não pode ser carregado.A custom attribute type cannot be loaded.

Se attributeType for null.If attributeType is null.

Esse membro pertence a um tipo carregado no contexto somente reflexão.This member belongs to a type that is loaded into the reflection-only context. Confira Como carregar assemblies no contexto somente de reflexão.See How to: Load Assemblies into the Reflection-Only Context.

Exemplos

O exemplo a seguir define uma classe BaseClass chamada que tem dois membros não herdados: um campo estático de total thread chamado e um método não compatível com CLS MethodAchamado.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. Uma classe chamada DerivedClass herda de BaseClass e substitui seu MethodA método.A class named DerivedClass inherits from BaseClass and overrides its MethodA method. Observe que nenhum atributo é aplicado aos membros de DerivedClass.Note that no attributes are applied to the members of DerivedClass. O exemplo itera os membros de DerivedClass para determinar se o CLSCompliantAttribute atributo ou ThreadStaticAttribute foi aplicado a eles.The example iterates the members of DerivedClass to determine whether the CLSCompliantAttribute or ThreadStaticAttribute attribute as been applied to them. Como inherit DerivedClass é true, o método pesquisa a hierarquia de herança do para o atributo especificado.Because inherit is true, the method searches the inheritance hierarchy of DerivedClass for the specified attribute. Como a saída do exemplo total mostra, o campo é decorado com o ThreadStaticAttribute atributo e o MethodA método é decorado com o CLSCompliantAttribute atributo.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

Comentários

Esse método ignora o inherit parâmetro para propriedades e eventos.This method ignores the inherit parameter for properties and events. Para pesquisar os atributos da cadeia de herança em Propriedades e eventos, use as sobrecargas apropriadas do Attribute.GetCustomAttributes método.To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

Observação

No .NET Framework versão 2,0, esse método retorna atributos de segurança em métodos, construtores e tipos se os atributos são armazenados no novo formato de metadados.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. Os assemblies compilados com a versão 2,0 usam esse formato.Assemblies compiled with version 2.0 use this format. Assemblies dinâmicos e assemblies compilados com versões anteriores do .NET Framework usam o formato XML antigo.Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. Consulte emitindo atributos de segurança declarativos.See Emitting Declarative Security Attributes.

Aplica-se a