MemberInfo.GetCustomAttributes Method (Boolean)
.NET Framework 2.0
When overridden in a derived class, returns an array containing all the custom attributes.
Namespace: System.Reflection
Assembly: mscorlib (in mscorlib.dll)
Assembly: mscorlib (in mscorlib.dll)
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.
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 ); } }
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.
Community Additions
ADD
Show: