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)

public abstract Object[] GetCustomAttributes (
	bool inherit
)
public abstract Object[] GetCustomAttributes (
	boolean inherit
)
public abstract function GetCustomAttributes (
	inherit : boolean
) : Object[]
Not applicable.

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.

Exception typeCondition

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 cannot be loaded.

NoteNote:

   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.

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);
        }
    }
}

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 Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft