MemberInfo.GetCustomAttributes Méthode

Référence

Définition

Espace de noms:: System.Reflection

Assemblys:: netstandard.dll, System.Runtime.dll

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

En cas de substitution dans une classe dérivée, retourne les attributs personnalisés appliqués à ce membre.

Surcharges

GetCustomAttributes(Boolean)	En cas de substitution dans une classe dérivée, retourne un tableau de tous les attributs personnalisés appliqués à ce membre.
GetCustomAttributes(Type, Boolean)	En cas de substitution dans une classe dérivée, retourne un tableau d’attributs personnalisés appliqués à ce membre et identifiés par Type.

GetCustomAttributes(Boolean)

Source:: MemberInfo.cs

Source:: MemberInfo.cs

Source:: MemberInfo.cs

En cas de substitution dans une classe dérivée, retourne un tableau de tous les attributs personnalisés appliqués à ce membre.

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

Paramètres

inherit: Boolean

true pour rechercher la chaîne d’héritage de ce membre afin de trouver les attributs ; sinon, false. Ce paramètre est ignoré pour les propriétés et les événements.

Retours

Object[]

Tableau contenant tous les attributs personnalisés appliqués à ce membre, ou tableau contenant 0 (zéro) élément si aucun attribut n'est défini.

Implémente

GetCustomAttributes(Boolean) GetCustomAttributes(Boolean)

Exceptions

InvalidOperationException

Ce membre appartient à un type qui est chargé dans le contexte de réflexion uniquement. Voir Guide pratique pour charger des assemblys dans le contexte de réflexion uniquement.

TypeLoadException

Un type d'attribut personnalisé ne peut pas être chargé.

Exemples

L’exemple suivant définit un attribut personnalisé et associe l’attribut à MyClass.MyMethod, récupère l’attribut au moment de l’exécution et affiche le résultat.

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

Remarques

Cette méthode ignore le paramètre pour les inherit propriétés et les événements. Pour rechercher des attributs sur des propriétés et des événements dans la chaîne d’héritage, utilisez les surcharges appropriées de la Attribute.GetCustomAttributes méthode .

Note

Dans le .NET Framework version 2.0, cette méthode retourne des attributs de sécurité sur les méthodes, les constructeurs et les types s’ils sont stockés dans le nouveau format de métadonnées. Les assemblys compilés avec la version 2.0 utilisent ce format. Les assemblys dynamiques et les assemblys compilés avec des versions antérieures du .NET Framework utilisent l’ancien format XML. Consultez Émission d’attributs de sécurité déclaratifs.

Voir aussi

S’applique à

.NET 10 et autres versions

Produit	Versions
.NET	Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

GetCustomAttributes(Type, Boolean)

Source:: MemberInfo.cs

Source:: MemberInfo.cs

Source:: MemberInfo.cs

En cas de substitution dans une classe dérivée, retourne un tableau d’attributs personnalisés appliqués à ce membre et identifiés par 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()

Paramètres

attributeType: Type

Type d’attribut à rechercher. Seuls les attributs qui peuvent être assignés à ce type sont retournés.

inherit: Boolean

true pour rechercher la chaîne d’héritage de ce membre afin de trouver les attributs ; sinon, false. Ce paramètre est ignoré pour les propriétés et les événements.

Retours

Object[]

Tableau d’attributs personnalisés appliqués à ce membre, ou tableau avec zéro élément si aucun attribut pouvant être assigné à attributeType n'a été appliqué.

Implémente

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

Exceptions

TypeLoadException

Un type d’attribut personnalisé ne peut pas être chargé.

ArgumentNullException

Si attributeType est null.

InvalidOperationException

Ce membre appartient à un type qui est chargé dans le contexte de réflexion uniquement. Voir Guide pratique pour charger des assemblys dans le contexte de réflexion uniquement.

Exemples

L’exemple suivant définit une classe nommée BaseClass qui a deux membres non hérités : un champ statique de thread nommé total et une méthode non conforme CLS nommée MethodA. Une classe nommée DerivedClass hérite de BaseClass et remplace sa MethodA méthode. Notez qu’aucun attribut n’est appliqué aux membres de DerivedClass. L’exemple itère les membres de DerivedClass pour déterminer si l’attribut CLSCompliantAttribute ou ThreadStaticAttribute leur a été appliqué. Étant donné que inherit est true, la méthode recherche l’attribut spécifié dans la hiérarchie d’héritage de DerivedClass . Comme le montre la sortie de l’exemple, le total champ est décoré avec l’attribut ThreadStaticAttribute et la MethodA méthode est décorée avec l’attribut 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

Remarques

Note

Dans .NET Framework version 2.0, cette méthode retourne des attributs de sécurité sur les méthodes, les constructeurs et les types si les attributs sont stockés dans le nouveau format de métadonnées. Les assemblys compilés avec la version 2.0 utilisent ce format. Les assemblys dynamiques et les assemblys compilés avec des versions antérieures du .NET Framework utilisent l’ancien format XML. Consultez Émission d’attributs de sécurité déclaratifs.

S’applique à

.NET 10 et autres versions

Produit	Versions
.NET	Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

Partager via

MemberInfo.GetCustomAttributes Méthode

Définition

Surcharges

GetCustomAttributes(Boolean)

Paramètres

Retours

Implémente

Exceptions

Exemples

Remarques

Voir aussi

S’applique à

GetCustomAttributes(Type, Boolean)

Paramètres

Retours

Implémente

Exceptions

Exemples

Remarques

S’applique à

Ressources supplémentaires