CustomAttributeTypedArgument Struct

Definizione

Spazio dei nomi:

System.Reflection

Assembly:

netstandard.dll, System.Runtime.dll

Origine:

CustomAttributeTypedArgument.cs

Rappresenta un argomento di un attributo personalizzato nel contesto di sola reflection o un elemento di un argomento di matrice.

C#

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

Ereditarietà

Object

ValueType

CustomAttributeTypedArgument

Implementazioni

IEquatable<CustomAttributeTypedArgument>

Esempio

Nell'esempio seguente viene definito un attributo personalizzato con quattro costruttori e quattro proprietà. Due delle proprietà sono di sola lettura e vengono impostate usando i parametri posizionali dei costruttori. Le altre due proprietà sono di lettura/scrittura e possono essere impostate solo usando argomenti denominati. Una proprietà posizionale è una matrice di stringhe e una proprietà denominata è una matrice di numeri interi.

L'attributo viene applicato all'assembly, a un tipo dichiarato nell'assembly, a un metodo del tipo e a un parametro del metodo . Per questi casi vengono usati costruttori diversi. Quando viene eseguito, l'assembly viene caricato nel contesto di sola reflection e visualizza gli attributi personalizzati.

L'attributo applicato al tipo illustra le proprietà della matrice, con argomenti posizionali e denominati.

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:
*/

Commenti

Il codice esaminato nel contesto di sola reflection non può essere eseguito, quindi non è sempre possibile esaminare gli attributi personalizzati creando istanze di tali attributi e quindi esaminandone le proprietà, usando metodi come Attribute.GetCustomAttributes, MemberInfo.GetCustomAttributese così via. Se il codice per il tipo di attributo stesso viene caricato nel contesto di sola reflection, non può essere eseguito.

La struttura CustomAttributeNamedArgument viene utilizzata dalla classe CustomAttributeData per fornire l'accesso al tipo e al valore di un argomento posizionale specificato per un'istanza di attributo personalizzata, senza eseguire il costruttore dell'attributo. Fornisce inoltre l'accesso al tipo e al valore di un argomento denominato senza eseguire il codice della proprietà corrispondente del tipo di attributo personalizzato.

I tipi e i valori di tutti gli argomenti posizionali e denominati di un'istanza di attributo vengono forniti dalle strutture CustomAttributeTypedArgument. Gli attributi posizionali restituiti dalla proprietà CustomAttributeData.ConstructorArguments sono rappresentati direttamente da strutture CustomAttributeTypedArgument, ma gli argomenti denominati restituiti dalla proprietà CustomAttributeData.NamedArguments sono rappresentati da strutture CustomAttributeNamedArgument; per ottenere la struttura CustomAttributeTypedArgument per un argomento denominato, utilizzare la proprietà CustomAttributeNamedArgument.TypedValue.

Se un argomento è una matrice di valori, la proprietà Value del CustomAttributeTypedArgument che rappresenta l'argomento restituisce un ReadOnlyCollection<T> generico di oggetti CustomAttributeTypedArgument. Ogni oggetto CustomAttributeTypedArgument nell'insieme rappresenta l'elemento corrispondente della matrice.

Per creare istanze della classe CustomAttributeData, usare il metodo factory staticGetCustomAttributes.

Costruttori

CustomAttributeTypedArgument(Object)	Inizializza una nuova istanza della classe CustomAttributeTypedArgument con il valore specificato.
CustomAttributeTypedArgument(Type, Object)	Inizializza una nuova istanza della classe CustomAttributeTypedArgument con il tipo e il valore specificati.

Proprietà

ArgumentType	Ottiene il tipo dell'argomento o dell'elemento dell'argomento della matrice.
Value	Ottiene il valore dell'argomento per un argomento semplice o per un elemento di un argomento di matrice; ottiene una raccolta di valori per un argomento di matrice.

Metodi

Equals(CustomAttributeTypedArgument)	Indica se l'istanza corrente è uguale a un'altra istanza dello stesso tipo.
Equals(Object)	Indica se questa istanza e un oggetto specificato sono uguali.
GetHashCode()	Restituisce il codice hash per questa istanza.
ToString()	Restituisce una stringa costituita dal nome dell'argomento, dal segno di uguale e da una rappresentazione di stringa del valore dell'argomento.

Operatori

Equality(CustomAttributeTypedArgument, CustomAttributeTypedArgument)	Verifica se due strutture CustomAttributeTypedArgument sono equivalenti.
Inequality(CustomAttributeTypedArgument, CustomAttributeTypedArgument)	Verifica se due strutture CustomAttributeTypedArgument sono diverse.

Si applica a

Vedi anche

• CustomAttributeData
• CustomAttributeNamedArgument
• ReflectionOnlyLoad