Export (0) Print
Expand All

MemberInfo.GetCustomAttributes Method (Boolean)

When overridden in a derived class, returns an array containing all the custom attributes.

Namespace: System.Reflection
Assembly: mscorlib (in mscorlib.dll)

'Declaration
Public MustOverride Function GetCustomAttributes ( _
	inherit As Boolean _
) As Object()
'Usage
Dim instance As MemberInfo
Dim inherit As Boolean
Dim returnValue As Object()

returnValue = instance.GetCustomAttributes(inherit)
public abstract Object[] GetCustomAttributes (
	boolean inherit
)
public abstract function GetCustomAttributes (
	inherit : boolean
) : Object[]

Parameters

inherit

Specifies whether to search this member's inheritance chain to find the attributes.

Return Value

An array that contains all the custom attributes, or an array with zero elements if no attributes are defined.

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 '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

import System.*;
import System.Reflection.*;

// Define a custom attribute with one named parameter.
/** @attribute AttributeUsage(AttributeTargets.All)
 */
public class MyAttribute extends Attribute
{
    private String myName;

    public MyAttribute(String name)
    {
        myName = name;
    } //MyAttribute

    /** @property 
     */
    public String get_Name()
    {
        return myName;
    } //get_Name
} //MyAttribute

// Define a class that has the custom attribute associated 
// with one of its members.
public class MyClass1
{
    /** @attribute MyAttribute("This is an example attribute.")
     */
    public void MyMethod(int i)
    {
        return;
    } //MyMethod
} //MyClass1

public class MemberInfo_GetCustomAttributes
{
    public static void main(String[] args)
    {
        try {
            // Get the type of MyClass1.
            Type myType = MyClass1.class.ToType();

            // 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[] = ((MemberInfo)myMembers.get_Item(i)).
                    GetCustomAttributes(true);
                if (myAttributes.length > 0) {
                    Console.WriteLine("\nThe attributes for the member "
                        + "{0} are: \n", myMembers.get_Item(i));
                    for (int j = 0; j < myAttributes.length; j++) {
                        Console.WriteLine("The type of the attribute is {0}.", 
                            myAttributes.get_Item(j));
                    }
                }
            }
        }
        catch (System.Exception e) {
            Console.WriteLine("An exception occurred: {0}", e.get_Message());
        }
    } //main
} //MemberInfo_GetCustomAttributes

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft