MemberInfo.GetCustomAttributes メソッド

定義

派生クラスでオーバーライドされた場合、このメンバーに適用されているカスタム属性を返します。When overridden in a derived class, returns custom attributes applied to this member.

オーバーロード

GetCustomAttributes(Boolean)

派生クラスでオーバーライドされた場合、このメンバーに適用されているすべてのカスタム属性の配列を返します。When overridden in a derived class, returns an array of all custom attributes applied to this member.

GetCustomAttributes(Type, Boolean)

派生クラスでオーバーライドされた場合は、このメンバーに適用され、Type によって識別されるカスタム属性の配列を返します。When overridden in a derived class, returns an array of custom attributes applied to this member and identified by Type.

GetCustomAttributes(Boolean)

派生クラスでオーバーライドされた場合、このメンバーに適用されているすべてのカスタム属性の配列を返します。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()

パラメーター

inherit
Boolean

このメンバーの継承チェーンを検索して属性を見つける場合は true。それ以外の場合は falsetrue to search this member's inheritance chain to find the attributes; otherwise, false. プロパティとイベントの場合、このパラメーターは無視されます。This parameter is ignored for properties and events.

戻り値

Object[]

このメンバーに適用されているすべてのカスタム属性が格納されている配列。定義されている属性がない場合は要素がゼロの配列。An array that contains all the custom attributes applied to this member, or an array with zero elements if no attributes are defined.

実装

例外

このメンバーは、リフレクションのみのコンテキストに読み込まれる型に属します。This member belongs to a type that is loaded into the reflection-only context. 方法: リフレクションのみのコンテキストにアセンブリを読み込む」を参照してください。See How to: Load Assemblies into the Reflection-Only Context.

カスタム属性の型を読み込むことができませんでした。A custom attribute type could not be loaded.

次の例では、カスタム属性を定義し、 MyClass.MyMethod属性をに関連付けて、実行時に属性を取得し、結果を表示します。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

注釈

このメソッドは、 inheritプロパティとイベントのパラメーターを無視します。This method ignores the inherit parameter for properties and events. 継承チェーンでプロパティとイベントの属性を検索するには、 Attribute.GetCustomAttributesメソッドの適切なオーバーロードを使用します。To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

注意

.NET Framework バージョン2.0 では、新しいメタデータ形式で格納されている場合、このメソッドはメソッド、コンストラクター、および型のセキュリティ属性を返します。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. バージョン2.0 でコンパイルされたアセンブリは、この形式を使用します。Assemblies compiled with version 2.0 use this format. 以前のバージョンの .NET Framework でコンパイルされた動的アセンブリとアセンブリは、古い XML 形式を使用します。Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. 宣言型セキュリティ属性の出力」を参照してください。See Emitting Declarative Security Attributes.

こちらもご覧ください

GetCustomAttributes(Type, Boolean)

派生クラスでオーバーライドされた場合は、このメンバーに適用され、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()

パラメーター

attributeType
Type

検索する属性の種類。The type of attribute to search for. この型に代入可能な属性だけが返されます。Only attributes that are assignable to this type are returned.

inherit
Boolean

このメンバーの継承チェーンを検索して属性を見つける場合は true。それ以外の場合は falsetrue to search this member's inheritance chain to find the attributes; otherwise, false. プロパティとイベントの場合、このパラメーターは無視されます。This parameter is ignored for properties and events.

戻り値

Object[]

このメンバーに適用されるカスタム属性の配列、または 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.

実装

例外

カスタム属性の型を読み込むことはできません。A custom attribute type cannot be loaded.

attributeTypenull の場合。If attributeType is null.

このメンバーは、リフレクションのみのコンテキストに読み込まれる型に属します。This member belongs to a type that is loaded into the reflection-only context. 方法: リフレクションのみのコンテキストにアセンブリを読み込む」を参照してください。See How to: Load Assemblies into the Reflection-Only Context.

次の例では、2 BaseClassつの非継承メンバーを持つという名前のクラスをtotal定義します。このクラスには、 MethodAという名前のスレッド静的フィールドと、という名前の 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. という名前DerivedClassのクラスBaseClassは、をMethodA継承し、そのメソッドをオーバーライドします。A class named DerivedClass inherits from BaseClass and overrides its MethodA method. DerivedClassメンバーには属性が適用されないことに注意してください。Note that no attributes are applied to the members of DerivedClass. この例では、のDerivedClassメンバーを反復処理CLSCompliantAttributeThreadStaticAttributeて、属性または属性が適用されているかどうかを判断します。The example iterates the members of DerivedClass to determine whether the CLSCompliantAttribute or ThreadStaticAttribute attribute as been applied to them. inherit DerivedClassであるため、メソッドは、指定された属性のの継承階層を検索します。 trueBecause inherit is true, the method searches the inheritance hierarchy of DerivedClass for the specified attribute. この例のtotal出力が示すように、フィールドはThreadStaticAttribute属性MethodAで修飾され、メソッドは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

注釈

このメソッドは、 inheritプロパティとイベントのパラメーターを無視します。This method ignores the inherit parameter for properties and events. 継承チェーンでプロパティとイベントの属性を検索するには、 Attribute.GetCustomAttributesメソッドの適切なオーバーロードを使用します。To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

注意

.NET Framework バージョン2.0 では、属性が新しいメタデータ形式で格納されている場合、このメソッドはメソッド、コンストラクター、および型のセキュリティ属性を返します。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. バージョン2.0 でコンパイルされたアセンブリは、この形式を使用します。Assemblies compiled with version 2.0 use this format. 以前のバージョンの .NET Framework でコンパイルされた動的アセンブリとアセンブリは、古い XML 形式を使用します。Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. 宣言型セキュリティ属性の出力」を参照してください。See Emitting Declarative Security Attributes.

適用対象