CustomAttributeTypedArgument Struktura

Definicja

Przestrzeń nazw:

System.Reflection

Zestawy:

netstandard.dll, System.Runtime.dll

Źródło:

CustomAttributeTypedArgument.cs

Reprezentuje argument atrybutu niestandardowego w kontekście tylko odbicia lub element argumentu tablicy.

C#

public readonly struct CustomAttributeTypedArgument : IEquatable<System.Reflection.CustomAttributeTypedArgument>

Dziedziczenie

Object

ValueType

CustomAttributeTypedArgument

Implementuje

IEquatable<CustomAttributeTypedArgument>

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 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 są używane różne konstruktory. Po wykonaniu zestaw ładuje się do kontekstu tylko odbicia i wyświetla atrybuty niestandardowe.

Atrybut stosowany do typu demonstruje 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ć.

Struktura CustomAttributeNamedArgument jest używana przez klasę CustomAttributeData w celu zapewnienia dostępu do typu i wartości argumentu pozycyjnego określonego dla wystąpienia atrybutu niestandardowego bez wykonywania konstruktora atrybutu. Zapewnia również dostęp do typu i wartości nazwanego argumentu bez wykonywania kodu odpowiadającej mu właściwości niestandardowego typu atrybutu.

Typy i wartości wszystkich pozycyjnych i nazwanych argumentów wystąpienia atrybutu są udostępniane przez struktury CustomAttributeTypedArgument. Atrybuty pozycyjne zwracane przez właściwość CustomAttributeData.ConstructorArguments są bezpośrednio reprezentowane przez struktury CustomAttributeTypedArgument, ale nazwane argumenty zwracane przez właściwość CustomAttributeData.NamedArguments są reprezentowane przez struktury CustomAttributeNamedArgument; aby uzyskać strukturę CustomAttributeTypedArgument dla nazwanego argumentu, użyj właściwości CustomAttributeNamedArgument.TypedValue.

Jeśli argument jest tablicą wartości, właściwość ValueCustomAttributeTypedArgument, która reprezentuje argument zwraca ogólny ReadOnlyCollection<T> obiektów CustomAttributeTypedArgument. Każdy obiekt CustomAttributeTypedArgument w kolekcji reprezentuje odpowiedni element tablicy.

Aby utworzyć wystąpienia klasy CustomAttributeData, użyj metody staticGetCustomAttributes factory.

Konstruktory

CustomAttributeTypedArgument(Object)	Inicjuje nowe wystąpienie klasy CustomAttributeTypedArgument z określoną wartością.
CustomAttributeTypedArgument(Type, Object)	Inicjuje nowe wystąpienie klasy CustomAttributeTypedArgument z określonym typem i wartością.

Właściwości

ArgumentType	Pobiera typ argumentu lub elementu argumentu tablicy.
Value	Pobiera wartość argumentu dla prostego argumentu lub elementu argumentu tablicy; pobiera kolekcję wartości dla argumentu tablicy.

Metody

Equals(CustomAttributeTypedArgument)	Wskazuje, czy bieżące wystąpienie jest równe innemu wystąpieniu tego samego typu.
Equals(Object)	Wskazuje, czy to wystąpienie i określony obiekt są równe.
GetHashCode()	Zwraca kod skrótu dla tego wystąpienia.
ToString()	Zwraca ciąg składający się z nazwy argumentu, znaku równości i ciągu reprezentującego wartość argumentu.

Operatory

Equality(CustomAttributeTypedArgument, CustomAttributeTypedArgument)	Sprawdza, czy dwie struktury CustomAttributeTypedArgument są równoważne.
Inequality(CustomAttributeTypedArgument, CustomAttributeTypedArgument)	Sprawdza, czy dwie struktury CustomAttributeTypedArgument są różne.

Dotyczy

Zobacz też

• CustomAttributeData
• CustomAttributeNamedArgument
• ReflectionOnlyLoad