MemberInfo.GetCustomAttributes Metod
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
När det åsidosättas i en härledd klass returneras anpassade attribut som tillämpas på den här medlemmen.
Överlagringar
| Name | Description |
|---|---|
| GetCustomAttributes(Boolean) |
När den åsidosättas i en härledd klass returnerar en matris med alla anpassade attribut som tillämpas på den här medlemmen. |
| GetCustomAttributes(Type, Boolean) |
När den åsidosättas i en härledd klass returnerar en matris med anpassade attribut som tillämpas på den här medlemmen och identifieras av Type. |
GetCustomAttributes(Boolean)
När den åsidosättas i en härledd klass returnerar en matris med alla anpassade attribut som tillämpas på den här medlemmen.
public:
abstract cli::array <System::Object ^> ^ GetCustomAttributes(bool inherit);
public abstract object[] GetCustomAttributes(bool inherit);
abstract member GetCustomAttributes : bool -> obj[]
Public MustOverride Function GetCustomAttributes (inherit As Boolean) As Object()
Parametrar
- inherit
- Boolean
trueför att söka i den här medlemmens arvskedja för att hitta attributen; annars . false Den här parametern ignoreras för egenskaper och händelser.
Returer
En matris som innehåller alla anpassade attribut som tillämpas på den här medlemmen eller en matris med noll element om inga attribut har definierats.
Implementeringar
Undantag
Den här medlemmen tillhör en typ som läses in i kontexten endast reflektion. Se Så här: Läs in sammansättningar i Reflection-Only-kontexten.
Det gick inte att läsa in en anpassad attributtyp.
Exempel
I följande exempel definieras ett anpassat attribut och attributet associeras med MyClass.MyMethod, hämtar attributet vid körning och visar resultatet.
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);
}
}
}
Imports System.Reflection
' 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
Public ReadOnly Property Name() As String
Get
Return myName
End Get
End Property
End Class
' 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
End Class
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
End Class
Kommentarer
Den här metoden ignorerar parametern inherit för egenskaper och händelser. Om du vill söka i arvskedjan efter attribut för egenskaper och händelser använder du lämpliga överlagringar av Attribute.GetCustomAttributes metoden.
Note
I .NET Framework version 2.0 returnerar den här metoden säkerhetsattribut på metoder, konstruktorer och typer om de lagras i det nya metadataformatet. Sammansättningar som kompilerats med version 2.0 använder det här formatet. Dynamiska sammansättningar och sammansättningar som kompilerats med tidigare versioner av .NET Framework använder det gamla XML-formatet. Se Generera deklarativa säkerhetsattribut.
Se även
Gäller för
GetCustomAttributes(Type, Boolean)
När den åsidosättas i en härledd klass returnerar en matris med anpassade attribut som tillämpas på den här medlemmen och identifieras av Type.
public:
abstract cli::array <System::Object ^> ^ GetCustomAttributes(Type ^ attributeType, bool inherit);
public abstract object[] GetCustomAttributes(Type attributeType, bool inherit);
abstract member GetCustomAttributes : Type * bool -> obj[]
Public MustOverride Function GetCustomAttributes (attributeType As Type, inherit As Boolean) As Object()
Parametrar
- attributeType
- Type
Typ av attribut att söka efter. Endast attribut som kan tilldelas den här typen returneras.
- inherit
- Boolean
trueför att söka i den här medlemmens arvskedja för att hitta attributen; annars . false Den här parametern ignoreras för egenskaper och händelser.
Returer
En matris med anpassade attribut som tillämpas på den här medlemmen eller en matris med noll element om inga attribut som kan attributeType tilldelas har tillämpats.
Implementeringar
Undantag
Det går inte att läsa in en anpassad attributtyp.
Om attributeType är null.
Den här medlemmen tillhör en typ som läses in i kontexten endast reflektion. Se Så här: Läs in sammansättningar i Reflection-Only-kontexten.
Exempel
I följande exempel definieras en klass med namnet BaseClass som har två icke-ärvda medlemmar: ett statiskt trådfält med namnet total och en icke-CLS-kompatibel metod med namnet MethodA. En klass med namnet DerivedClass ärver från BaseClass och åsidosätter dess MethodA metod. Observera att inga attribut tillämpas på medlemmarna DerivedClassi . Exemplet itererar medlemmarna DerivedClass i för att avgöra om CLSCompliantAttribute attributet eller ThreadStaticAttribute som har tillämpats på dem. Eftersom inherit är truesöker metoden arvshierarkin DerivedClass efter det angivna attributet. Som utdata från exemplet visar är fältet total dekorerat med ThreadStaticAttribute attributet och MethodA metoden är dekorerad med CLSCompliantAttribute attributet.
using System;
public class BaseClass
{
[ThreadStatic] public int total;
[CLSCompliant(false)] public virtual uint MethodA()
{
return (uint) 100;
}
}
public class DerivedClass : BaseClass
{
public override uint MethodA()
{
total++;
return 200;
}
}
public class Example
{
public static void Main()
{
Type t = typeof(DerivedClass);
Console.WriteLine("Members of {0}:", t.FullName);
foreach (var m in t.GetMembers())
{
bool hasAttribute = false;
Console.Write(" {0}: ", m.Name);
if (m.GetCustomAttributes(typeof(CLSCompliantAttribute), true).Length > 0) {
Console.Write("CLSCompliant");
hasAttribute = true;
}
if (m.GetCustomAttributes(typeof(ThreadStaticAttribute), true).Length > 0) {
Console.Write("ThreadStatic");
hasAttribute = true;
}
if (!hasAttribute)
Console.Write("No attributes");
Console.WriteLine();
}
}
}
// The example displays the following output:
// Members of DerivedClass:
// MethodA: CLSCompliant
// ToString: No attributes
// Equals: No attributes
// GetHashCode: No attributes
// typeof: No attributes
// .ctor: No attributes
// total: ThreadStatic
Public Class BaseClass
<ThreadStatic> Public total As Integer
<CLSCompliant(False)> Public Overridable Function MethodA() As UInt32
Return CUInt(100)
End Function
End Class
Public Class DerivedClass : Inherits BaseClass
Public Overrides Function MethodA() As UInt32
total += 1
Return 200
End Function
End Class
Module Example
Public Sub Main()
Dim t As Type = GetType(DerivedClass)
Console.WriteLine("Members of {0}:", t.FullName)
For Each m In t.GetMembers()
Dim hasAttribute As Boolean = False
Console.Write(" {0}: ", m.Name)
If m.GetCustomAttributes(GetType(CLSCompliantAttribute), True).Length > 0 Then
Console.Write("CLSCompliant")
hasAttribute = True
End If
If m.GetCustomAttributes(GetType(ThreadStaticAttribute), True).Length > 0 Then
Console.Write("ThreadStatic")
hasAttribute = True
End If
If Not hasAttribute Then
Console.Write("No attributes")
End If
Console.WriteLine()
Next
End Sub
End Module
' The example displays the following output:
' Members of DerivedClass:
' MethodA: CLSCompliant
' ToString: No attributes
' Equals: No attributes
' GetHashCode: No attributes
' GetType: No attributes
' .ctor: No attributes
' total: ThreadStatic
Kommentarer
Den här metoden ignorerar parametern inherit för egenskaper och händelser. Om du vill söka i arvskedjan efter attribut för egenskaper och händelser använder du lämpliga överlagringar av Attribute.GetCustomAttributes metoden.
Note
I .NET Framework version 2.0 returnerar den här metoden säkerhetsattribut på metoder, konstruktorer och typer om attributen lagras i det nya metadataformatet. Sammansättningar som kompilerats med version 2.0 använder det här formatet. Dynamiska sammansättningar och sammansättningar som kompilerats med tidigare versioner av .NET Framework använder det gamla XML-formatet. Se Generera deklarativa säkerhetsattribut.