MemberInfo.GetCustomAttributes Метод

Ссылка

Определение

Пространство имен:: System.Reflection

Сборка:: System.Runtime.dll

Сборка:: mscorlib.dll

Сборка:: netstandard.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

При переопределении в производном классе возвращает настраиваемые атрибуты, примененные к этому члену.

Перегрузки

GetCustomAttributes(Boolean)	При переопределении в производном классе возвращает массив всех настраиваемых атрибутов, примененных к данному члену.
GetCustomAttributes(Type, Boolean)	При переопределении в производном классе возвращает массив настраиваемых атрибутов, применяемых к этому элементу и определяемых параметром Type.

GetCustomAttributes(Boolean)

При переопределении в производном классе возвращает массив всех настраиваемых атрибутов, примененных к данному члену.

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 для поиска атрибутов в цепочке наследования этого элемента. В противном случае — false. Этот параметр игнорируется для свойств и событий.

Возвращаемое значение

Object[]

Массив, содержащий все настраиваемые атрибуты, примененные к данному члену, или массив с нулем элементов, если атрибуты не определены.

Реализации

GetCustomAttributes(Boolean) GetCustomAttributes(Boolean)

Исключения

InvalidOperationException

Этот элемент загружается в контекст, предназначенный только для отражения. См. раздел Практическое руководство. Загрузка сборок в контекст, предназначенный только для отражения.

TypeLoadException

Не удалось загрузить тип настраиваемого атрибута.

Примеры

В следующем примере определяется пользовательский атрибут и атрибут связывается с MyClass.MyMethodним, извлекается атрибут во время выполнения и отображается результат.

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 параметр для свойств и событий. Для поиска цепочки наследования атрибутов по свойствам и событиям используйте соответствующие перегрузки Attribute.GetCustomAttributes метода.

Примечание

В платформа .NET Framework версии 2.0 этот метод возвращает атрибуты безопасности для методов, конструкторов и типов, если они хранятся в новом формате метаданных. Сборки, скомпилированные с версией 2.0, используют этот формат. Динамические сборки и сборки, скомпилированные с более ранними версиями платформа .NET Framework используют старый формат XML. См. раздел "Выдача декларативных атрибутов безопасности".

См. также раздел

Применяется к

GetCustomAttributes(Type, Boolean)

При переопределении в производном классе возвращает массив настраиваемых атрибутов, применяемых к этому элементу и определяемых параметром 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

Тип атрибута для поиска. Возвращаются только те атрибуты, которые можно назначить этому типу.

inherit: Boolean

Возвращаемое значение

Object[]

Массив настраиваемых атрибутов, применяемых к этому элементу, или массив без элементов, если не применены атрибуты, которые можно назначить attributeType.

Реализации

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

Исключения

TypeLoadException

Не удалось загрузить тип настраиваемого атрибута.

ArgumentNullException

Если attributeType имеет значение null.

InvalidOperationException

Примеры

В следующем примере определяется класс с двумя BaseClass ненаследуемыми элементами: статическое поле потока с именем total MethodAи несоответствующий методу CLS. Класс с именем DerivedClass наследует и BaseClass переопределяет его MethodA метод. Обратите внимание, что атрибуты не применяются к членам DerivedClass. В этом примере выполняется итератор элементов, определяющих DerivedClass , применен ли CLSCompliantAttribute к ним атрибут или ThreadStaticAttribute атрибут. Так как inherit метод trueвыполняет поиск иерархии наследования для указанного DerivedClass атрибута. Как показано в выходных данных из примера, total поле декорируется ThreadStaticAttribute атрибутом, а MethodA метод декорируется атрибутом 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

В платформа .NET Framework версии 2.0 этот метод возвращает атрибуты безопасности для методов, конструкторов и типов, если атрибуты хранятся в новом формате метаданных. Сборки, скомпилированные с версией 2.0, используют этот формат. Динамические сборки и сборки, скомпилированные с более ранними версиями платформа .NET Framework используют старый формат XML. См. раздел "Выдача декларативных атрибутов безопасности".

Применяется к

MemberInfo.GetCustomAttributes Метод

Определение

Перегрузки

GetCustomAttributes(Boolean)

Параметры

Возвращаемое значение

Реализации

Исключения

Примеры

Комментарии

См. также раздел

Применяется к

GetCustomAttributes(Type, Boolean)

Параметры

Возвращаемое значение

Реализации

Исключения

Примеры

Комментарии

Применяется к

Дополнительные ресурсы