MemberInfo.GetCustomAttributes Method (Boolean)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
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.
Implements
ICustomAttributeProvider.GetCustomAttributes(Boolean)| Exception | Condition |
|---|---|
| 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.
Version Notes
Windows Phone
Some attribute constructor arguments and property values can cause MemberInfo.GetCustomAttributes to fail.The following example defines a custom attribute and associates the attribute with MyClass.MyMethod, retrieves the attribute at run time, and displays the result.
Note: |
|---|
To run this example, see Building examples that have static TextBlock controls for Windows Phone 8. |
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 Example { public static void Demo(System.Windows.Controls.TextBlock outputBlock) { 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) { outputBlock.Text += String.Format("\nThe attributes for the member {0} are: \n", myMembers[i]) + "\n"; for (int j = 0; j < myAttributes.Length; j++) outputBlock.Text += String.Format("The type of the attribute is {0}.", myAttributes[j]) + "\n"; } } } catch (Exception e) { outputBlock.Text += String.Format("An exception occurred: {0}", e.Message) + "\n"; } } }
Note: