MemberInfo.GetCustomAttributes Method (Boolean)
When overridden in a derived class, returns an array of all custom attributes applied to this member.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- inherit
-
Type:
System.Boolean
true to search this member's inheritance chain to find the attributes; otherwise, false. This parameter is ignored for properties and events; see Remarks.
Return Value
Type: System.Object()An array that contains all the custom attributes applied to this member, or an array with zero elements if no attributes are defined.
| Exception | Condition |
|---|---|
| InvalidOperationException | This member belongs to a type that is loaded into the reflection-only context. See How to: Load Assemblies into the Reflection-Only Context. |
| TypeLoadException | A custom attribute type could not be loaded. |
This method ignores the inherit parameter for properties and events. To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.
Note |
|---|
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. Assemblies compiled with version 2.0 use this format. Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. See Emitting Declarative Security Attributes. |
The following example defines a custom attribute and associates the attribute with MyClass.MyMethod, retrieves the attribute at run time, and displays the result.
Imports System Imports System.Reflection Imports Microsoft.VisualBasic ' 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 'NewNew 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
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
