CustomAttributeData Klasa

Definicja

Zapewnia dostęp do niestandardowych danych atrybutów dla zestawów, modułów, typów, elementów członkowskich i parametrów, które są ładowane do kontekstu tylko odbicia.

C#
public class CustomAttributeData
C#
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public sealed class CustomAttributeData
C#
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class CustomAttributeData
Dziedziczenie
CustomAttributeData
Atrybuty

Przykłady

W poniższym przykładzie zdefiniowano atrybut niestandardowy z czterema konstruktorami i czterema właściwościami. Dwie właściwości są tylko do odczytu i są ustawiane przy użyciu parametrów pozycyjnych konstruktorów. Pozostałe dwie właściwości to odczyt/zapis i można je ustawić tylko przy użyciu nazwanych argumentów. Jedna właściwość pozycyjna to tablica ciągów, a jedna nazwana właściwość jest tablicą liczb całkowitych.

Atrybut jest stosowany do zestawu, do typu zadeklarowanego w zestawie, do metody typu i do parametru metody metody . W tych przypadkach używane są różne konstruktory. Po wykonaniu zestaw ładuje się do kontekstu tylko odbicia i wyświetla informacje o atrybutach niestandardowych, które zostały do niego zastosowane, oraz do typu i elementów członkowskich, które zawiera.

Atrybut stosowany do typu pokazuje właściwości tablicy z argumentami pozycyjnymi i nazwanymi.

C#
using System;
using System.Reflection;
using System.Collections.Generic;
using System.Collections.ObjectModel;

// The example attribute is applied to the assembly.
[assembly:Example(ExampleKind.ThirdKind, Note="This is a note on the assembly.")]

// An enumeration used by the ExampleAttribute class.
public enum ExampleKind
{
    FirstKind,
    SecondKind,
    ThirdKind,
    FourthKind
};

// An example attribute. The attribute can be applied to all
// targets, from assemblies to parameters.
//
[AttributeUsage(AttributeTargets.All)]
public class ExampleAttribute : Attribute
{
    // Data for properties.
    private ExampleKind kindValue;
    private string noteValue;
    private string[] arrayStrings;
    private int[] arrayNumbers;

    // Constructors. The parameterless constructor (.ctor) calls
    // the constructor that specifies ExampleKind and an array of
    // strings, and supplies the default values.
    //
    public ExampleAttribute(ExampleKind initKind, string[] initStrings)
    {
        kindValue = initKind;
        arrayStrings = initStrings;
    }
    public ExampleAttribute(ExampleKind initKind) : this(initKind, null) {}
    public ExampleAttribute() : this(ExampleKind.FirstKind, null) {}

    // Properties. The Note and Numbers properties must be read/write, so they
    // can be used as named parameters.
    //
    public ExampleKind Kind { get { return kindValue; }}
    public string[] Strings { get { return arrayStrings; }}
    public string Note
    {
        get { return noteValue; }
        set { noteValue = value; }
    }
    public int[] Numbers
    {
        get { return arrayNumbers; }
        set { arrayNumbers = value; }
    }
}

// The example attribute is applied to the test class.
//
[Example(ExampleKind.SecondKind,
         new string[] { "String array argument, line 1",
                        "String array argument, line 2",
                        "String array argument, line 3" },
         Note="This is a note on the class.",
         Numbers = new int[] { 53, 57, 59 })]
public class Test
{
    // The example attribute is applied to a method, using the
    // parameterless constructor and supplying a named argument.
    // The attribute is also applied to the method parameter.
    //
    [Example(Note="This is a note on a method.")]
    public void TestMethod([Example] object arg) { }

    // Main() gets objects representing the assembly, the test
    // type, the test method, and the method parameter. Custom
    // attribute data is displayed for each of these.
    //
    public static void Main()
    {
        Assembly asm = Assembly.ReflectionOnlyLoad("Source");
        Type t = asm.GetType("Test");
        MethodInfo m = t.GetMethod("TestMethod");
        ParameterInfo[] p = m.GetParameters();

        Console.WriteLine("\r\nAttributes for assembly: '{0}'", asm);
        ShowAttributeData(CustomAttributeData.GetCustomAttributes(asm));
        Console.WriteLine("\r\nAttributes for type: '{0}'", t);
        ShowAttributeData(CustomAttributeData.GetCustomAttributes(t));
        Console.WriteLine("\r\nAttributes for member: '{0}'", m);
        ShowAttributeData(CustomAttributeData.GetCustomAttributes(m));
        Console.WriteLine("\r\nAttributes for parameter: '{0}'", p);
        ShowAttributeData(CustomAttributeData.GetCustomAttributes(p[0]));
    }

    private static void ShowAttributeData(
        IList<CustomAttributeData> attributes)
    {
        foreach( CustomAttributeData cad in attributes )
        {
            Console.WriteLine("   {0}", cad);
            Console.WriteLine("      Constructor: '{0}'", cad.Constructor);

            Console.WriteLine("      Constructor arguments:");
            foreach( CustomAttributeTypedArgument cata
                in cad.ConstructorArguments )
            {
                ShowValueOrArray(cata);
            }

            Console.WriteLine("      Named arguments:");
            foreach( CustomAttributeNamedArgument cana
                in cad.NamedArguments )
            {
                Console.WriteLine("         MemberInfo: '{0}'",
                    cana.MemberInfo);
                ShowValueOrArray(cana.TypedValue);
            }
        }
    }

    private static void ShowValueOrArray(CustomAttributeTypedArgument cata)
    {
        if (cata.Value.GetType() == typeof(ReadOnlyCollection<CustomAttributeTypedArgument>))
        {
            Console.WriteLine("         Array of '{0}':", cata.ArgumentType);

            foreach (CustomAttributeTypedArgument cataElement in
                (ReadOnlyCollection<CustomAttributeTypedArgument>) cata.Value)
            {
                Console.WriteLine("             Type: '{0}'  Value: '{1}'",
                    cataElement.ArgumentType, cataElement.Value);
            }
        }
        else
        {
            Console.WriteLine("         Type: '{0}'  Value: '{1}'",
                cata.ArgumentType, cata.Value);
        }
    }
}

/* This code example produces output similar to the following:

Attributes for assembly: 'source, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null'
   [System.Runtime.CompilerServices.CompilationRelaxationsAttribute((Int32)8)]
      Constructor: 'Void .ctor(Int32)'
      Constructor arguments:
         Type: 'System.Int32'  Value: '8'
      Named arguments:
   [System.Runtime.CompilerServices.RuntimeCompatibilityAttribute(WrapNonExceptionThrows = True)]
      Constructor: 'Void .ctor()'
      Constructor arguments:
      Named arguments:
         MemberInfo: 'Boolean WrapNonExceptionThrows'
         Type: 'System.Boolean'  Value: 'True'
   [ExampleAttribute((ExampleKind)2, Note = "This is a note on the assembly.")]
      Constructor: 'Void .ctor(ExampleKind)'
      Constructor arguments:
         Type: 'ExampleKind'  Value: '2'
      Named arguments:
         MemberInfo: 'System.String Note'
         Type: 'System.String'  Value: 'This is a note on the assembly.'

Attributes for type: 'Test'
   [ExampleAttribute((ExampleKind)1, new String[3] { "String array argument, line 1", "String array argument, line 2", "String array argument, line 3" }, Note = "This is a note on the class.", Numbers = new Int32[3] { 53, 57, 59 })]
      Constructor: 'Void .ctor(ExampleKind, System.String[])'
      Constructor arguments:
         Type: 'ExampleKind'  Value: '1'
         Array of 'System.String[]':
             Type: 'System.String'  Value: 'String array argument, line 1'
             Type: 'System.String'  Value: 'String array argument, line 2'
             Type: 'System.String'  Value: 'String array argument, line 3'
      Named arguments:
         MemberInfo: 'System.String Note'
         Type: 'System.String'  Value: 'This is a note on the class.'
         MemberInfo: 'Int32[] Numbers'
         Array of 'System.Int32[]':
             Type: 'System.Int32'  Value: '53'
             Type: 'System.Int32'  Value: '57'
             Type: 'System.Int32'  Value: '59'

Attributes for member: 'Void TestMethod(System.Object)'
   [ExampleAttribute(Note = "This is a note on a method.")]
      Constructor: 'Void .ctor()'
      Constructor arguments:
      Named arguments:
         MemberInfo: 'System.String Note'
         Type: 'System.String'  Value: 'This is a note on a method.'

Attributes for parameter: 'System.Object arg'
   [ExampleAttribute()]
      Constructor: 'Void .ctor()'
      Constructor arguments:
      Named arguments:
*/

Uwagi

Nie można wykonać kodu badanego w kontekście tylko odbicia, dlatego nie zawsze jest możliwe zbadanie atrybutów niestandardowych przez utworzenie wystąpień, a następnie zbadanie ich właściwości przy użyciu metod takich jak Attribute.GetCustomAttributes, MemberInfo.GetCustomAttributesitd. Jeśli kod samego typu atrybutu jest ładowany do kontekstu tylko odbicia, nie można go wykonać.

Klasa CustomAttributeData umożliwia badanie atrybutów niestandardowych w kontekście tylko odbicia, zapewniając abstrakcję atrybutów. Elementy członkowskie tej klasy mogą służyć do uzyskiwania argumentów pozycyjnych i nazwanych argumentów atrybutu. ConstructorArguments Użyj właściwości , aby uzyskać listę CustomAttributeTypedArgument struktur reprezentujących argumenty pozycyjne i użyć NamedArguments właściwości , aby uzyskać listę CustomAttributeNamedArgument struktur reprezentujących nazwane argumenty.

Uwaga

Struktura CustomAttributeNamedArgument zawiera tylko informacje o właściwości atrybutu używanej do pobierania i ustawiania wartości argumentu. Aby uzyskać typ i wartość argumentu, użyj CustomAttributeNamedArgument.TypedValue właściwości , aby uzyskać CustomAttributeTypedArgument strukturę.

Jeśli masz CustomAttributeTypedArgument strukturę argumentu o nazwie lub pozycji, użyj CustomAttributeTypedArgument.ArgumentType właściwości , aby uzyskać typ i CustomAttributeTypedArgument.Value właściwość w celu uzyskania wartości.

Uwaga

Dla argumentu tablicy CustomAttributeTypedArgument.Value właściwość zwraca rodzaj ReadOnlyCollection<T>CustomAttributeTypedArgument obiektów. Każdy CustomAttributeTypedArgument obiekt w kolekcji reprezentuje odpowiedni element tablicy.

CustomAttributeData można używać w kontekście wykonywania, a także w kontekście tylko odbicia. Możesz na przykład uniknąć ładowania zestawu zawierającego kod atrybutu niestandardowego. CustomAttributeData Użycie klasy różni się od metod takich jak Attribute.GetCustomAttributes:

  • Właściwości i metody zapewniania CustomAttributeData tylko wartości określonych dla wystąpienia atrybutu, a nie semantyki konstruktora. Na przykład argument ciągu atrybutu może zostać przekonwertowany wewnętrznie na inną reprezentację i zwrócony w postaci kanonicznej; lub właściwość może mieć skutki uboczne po wykonaniu rzeczywistego kodu atrybutu.

  • Właściwości i metody nie CustomAttributeData umożliwiają pobierania atrybutów niestandardowych dziedziczonej z klas bazowych.

Aby utworzyć wystąpienia CustomAttributeData klasy, użyj static metod fabryki (Shared w Visual Basic). GetCustomAttributes

Konstruktory

CustomAttributeData()

Inicjuje nowe wystąpienie klasy CustomAttributeData.

Właściwości

AttributeType

Pobiera typ atrybutu.

Constructor

ConstructorInfo Pobiera obiekt reprezentujący konstruktor, który zainicjowałby atrybut niestandardowy.

ConstructorArguments

Pobiera listę argumentów pozycyjnych określonych dla wystąpienia atrybutu reprezentowanego CustomAttributeData przez obiekt.

NamedArguments

Pobiera listę nazwanych argumentów określonych dla wystąpienia atrybutu reprezentowanego CustomAttributeData przez obiekt.

Metody

Equals(Object)

Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi.

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.

(Odziedziczone po Object)
GetCustomAttributes(Assembly)

Zwraca listę CustomAttributeData obiektów reprezentujących dane dotyczące atrybutów, które zostały zastosowane do zestawu docelowego.

GetCustomAttributes(MemberInfo)

Zwraca listę CustomAttributeData obiektów reprezentujących dane dotyczące atrybutów, które zostały zastosowane do elementu członkowskiego docelowego.

GetCustomAttributes(Module)

Zwraca listę CustomAttributeData obiektów reprezentujących dane dotyczące atrybutów, które zostały zastosowane do modułu docelowego.

GetCustomAttributes(ParameterInfo)

Zwraca listę CustomAttributeData obiektów reprezentujących dane dotyczące atrybutów, które zostały zastosowane do parametru docelowego.

GetHashCode()

Pełni rolę funkcji skrótu dla określonego typu.

GetHashCode()

Służy jako domyślna funkcja skrótu.

(Odziedziczone po Object)
GetType()

Type Pobiera bieżące wystąpienie.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
ToString()

Zwraca reprezentację ciągu atrybutu niestandardowego.

ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)

Dotyczy

Produkt Wersje
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

Zobacz też